Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"scripts": {
"snippet:generate": "tsx scripts/snippet-tool.ts generate",
"snippet:collapse": "tsx scripts/snippet-tool.ts collapse",
"snippet:expand": "tsx scripts/snippet-tool.ts expand"
"snippet:expand": "tsx scripts/snippet-tool.ts expand",
"snippet:document": "tsx scripts/snippet-tool.ts document"
},
"devDependencies": {
"@types/node": "^25.9.1",
Expand Down
14 changes: 10 additions & 4 deletions scripts/snippet-tool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,21 @@ async function generateStructure(options: Record<string, string>) {

for (const name of configurations) {
await writePlaceholder(path.join(root, "configurations", "brief", toFileName(name)), name);
await writePlaceholder(path.join(root, "configurations", "condition", toFileName(name)), `${name} condition`);
await writePlaceholder(path.join(root, "configurations", "flag", toFileName(`use_${name}`)), `use_${name}`);
}
for (const name of links) {
await writePlaceholder(path.join(root, "links", "brief", toFileName(name)), name);
await writePlaceholder(path.join(root, "links", "condition", toFileName(name)), `${name} condition`);
await writePlaceholder(path.join(root, "links", "flag", toFileName(`link_${name}`)), `link_${name}`);
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix link-flag snippet path contract mismatch.

generateStructure now creates links/flag/link_<name>.md, but the document builder still reads link flag descriptions from links/condition. This leaves new links/flag files unused and can generate broken references.

Suggested fix
-    const flagPath = getRelativeSnippetPath(snippetType, "links/condition", flagName);
+    const flagPath = getRelativeSnippetPath(snippetType, "links/flag", flagName);
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@scripts/snippet-tool.ts` at line 98, generateStructure now writes link flag
files to links/flag using writePlaceholder (e.g., writePlaceholder(...
"links/flag", ...)), but the document builder still loads link-flag docs from
links/condition, causing files under links/flag to be ignored; update the
document builder code that currently reads the "links/condition" directory
(search for any loader function or method that reads "links/condition", e.g.,
readLinkFlags/readLinks or the code path that parses condition files) to instead
read from "links/flag" (or adjust the read path to accept both locations),
ensuring the reader code and generateStructure (writePlaceholder) agree on
"links/flag" so new link_<name>.md files are consumed.

}
for (const name of modifiers) {
await writePlaceholder(path.join(root, "modifiers", "brief", toFileName(name)), name);
await writePlaceholder(path.join(root, "modifiers", "details", toFileName(name)), `${name} details`);
}
for (const name of records) {
await writePlaceholder(path.join(root, "records", "brief", toFileName(name)), name);
await writePlaceholder(path.join(root, "records", "condition", toFileName(name)), `${name} condition`);
}

console.log(`Generated snippet structure for table '${tableName}' at snippets/${tableName}`);
Expand Down Expand Up @@ -234,8 +239,8 @@ function generateConfigurationsSection(
lines.push("| --- | ---- | ----------- |");

for (let i = 0; i < configs.length; i++) {
const configBriefName = configs[i]; // e.g., "constant_codepoint_count"
const flagName = "use_" + configBriefName; // e.g., "use_constant_codepoint_count"
const configBriefName = configs[i]; // e.g., "constant_code_point_count"
const flagName = "use_" + configBriefName; // e.g., "use_constant_code_point_count"
const flagPath = getRelativeSnippetPath(snippetType, "configurations/flag", flagName);
lines.push(
`| ${i} | \`${flagName}\` | \\textinput{${flagPath}} |`
Expand Down Expand Up @@ -370,7 +375,7 @@ async function generateDocument(options: Record<string, string>) {

const tableDir = path.join(process.cwd(), "snippets", tableName);
const outputPath = path.resolve(
options.output || path.join(process.cwd(), `${tableName}.md`)
options.output || path.join(process.cwd(), `src/${tableName}.md`)
);

// Check if table directory exists
Expand Down Expand Up @@ -424,7 +429,8 @@ async function generateDocument(options: Record<string, string>) {
await fs.writeFile(outputPath, doc, "utf8");

console.log(
`Generated document for table '${tableName}' at ${path.relative(process.cwd(), outputPath)}`
`Generated document for table '${tableName}' at ${path.relative(process.cwd(), outputPath)}
Make sure to reorder fields accordingly!`
);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The exact codepoint length of each `code_points` field in this table

Check failure on line 1 in snippets/character_table/configurations/brief/constant_code_point_count.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/configurations/brief/constant_code_point_count.md#L1

[Vale.Spelling] Did you really mean 'codepoint'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'codepoint'?", "location": {"path": "snippets/character_table/configurations/brief/constant_code_point_count.md", "range": {"start": {"line": 1, "column": 11}}}, "severity": "ERROR"}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Resolve Vale spelling failure (codepoint).

CI is failing on this line. Replace codepoint with code point (or project-approved term) to satisfy the linter.

🧰 Tools
🪛 GitHub Actions: vale / vale

[error] 1-1: [Vale.Spelling] Did you really mean 'codepoint'?

🪛 GitHub Check: vale

[failure] 1-1: [vale] snippets/character_table/configurations/brief/constant_code_point_count.md#L1
[Vale.Spelling] Did you really mean 'codepoint'?

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@snippets/character_table/configurations/brief/constant_code_point_count.md`
at line 1, Replace the misspelled term "codepoint" with the project-approved
term "code point" in the documentation line that describes the exact codepoint
length for the `code_points` field (the string containing "codepoint" in the
brief description for constant_code_point_count). Update that single word so the
sentence reads "code point" to satisfy the Vale linter.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_code_point_count` is enabled.

Check warning on line 1 in snippets/character_table/configurations/condition/constant_code_point_count.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/configurations/condition/constant_code_point_count.md#L1

[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.", "location": {"path": "snippets/character_table/configurations/condition/constant_code_point_count.md", "range": {"start": {"line": 1, "column": 36}}}, "severity": "WARNING"}

Check notice on line 1 in snippets/character_table/configurations/condition/constant_code_point_count.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/configurations/condition/constant_code_point_count.md#L1

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "snippets/character_table/configurations/condition/constant_code_point_count.md", "range": {"start": {"line": 1, "column": 36}}}, "severity": "INFO"}

Check notice on line 1 in snippets/character_table/configurations/condition/constant_code_point_count.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/configurations/condition/constant_code_point_count.md#L1

[Google.Passive] In general, use active voice instead of passive voice ('is enabled').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is enabled').", "location": {"path": "snippets/character_table/configurations/condition/constant_code_point_count.md", "range": {"start": {"line": 1, "column": 36}}}, "severity": "INFO"}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All characters in this table have the same number of code points.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
UTF-8 encoded codepoint sequence (null-terminated unless `constant_codepoint_count` is set).
UTF-8 encoded codepoint sequence (null-terminated unless `constant_code_point_count` is set).

Check notice on line 1 in snippets/character_table/records/condition/code_points.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/code_points.md#L1

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "snippets/character_table/records/condition/code_points.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}

Check failure on line 1 in snippets/character_table/records/condition/code_points.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/code_points.md#L1

[Vale.Spelling] Did you really mean 'codepoint'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'codepoint'?", "location": {"path": "snippets/character_table/records/condition/code_points.md", "range": {"start": {"line": 1, "column": 15}}}, "severity": "ERROR"}

Check notice on line 1 in snippets/character_table/records/condition/code_points.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/code_points.md#L1

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "snippets/character_table/records/condition/code_points.md", "range": {"start": {"line": 1, "column": 86}}}, "severity": "INFO"}

Check notice on line 1 in snippets/character_table/records/condition/code_points.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/code_points.md#L1

[Google.Passive] In general, use active voice instead of passive voice ('is set').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "snippets/character_table/records/condition/code_points.md", "range": {"start": {"line": 1, "column": 86}}}, "severity": "INFO"}

Check warning on line 1 in snippets/character_table/records/condition/code_points.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/code_points.md#L1

[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.", "location": {"path": "snippets/character_table/records/condition/code_points.md", "range": {"start": {"line": 1, "column": 86}}}, "severity": "WARNING"}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix CI-blocking spelling in code_points condition text.

Vale fails on codepoint here as well. Please switch to code point (or the repository’s accepted spelling).

🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

[error] 1-1: Vale.Spelling: Did you really mean 'codepoint'?

🪛 GitHub Actions: vale / vale

[error] 1-1: [Vale.Spelling] Did you really mean 'codepoint'?

🪛 GitHub Check: vale

[notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[Google.Parens] Use parentheses judiciously.


[failure] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[Vale.Spelling] Did you really mean 'codepoint'?


[notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[write-good.E-Prime] Try to avoid using 'is'.


[notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[Google.Passive] In general, use active voice instead of passive voice ('is set').


[warning] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@snippets/character_table/records/condition/code_points.md` at line 1, The
phrase "codepoint" in the `code_points` condition text should use the
repository's accepted spelling "code point"; update the string "UTF-8 encoded
codepoint sequence (null-terminated unless `constant_code_point_count` is set)."
to "UTF-8 encoded code point sequence (null-terminated unless
`constant_code_point_count` is set)." in the `code_points` condition
documentation so Vale no longer flags it.

7 changes: 5 additions & 2 deletions snippets/color_table/brief.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# color_table table
Stores RGBA color values that can be referenced by pixmap data.

Check notice on line 1 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L1

[Google.Acronyms] Spell out 'RGBA', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'RGBA', if it's unfamiliar to the audience.", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 1, "column": 8}}}, "severity": "INFO"}

Check warning on line 1 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L1

[write-good.Passive] 'be referenced' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be referenced' may be passive voice. Use active voice if you can.", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 1, "column": 35}}}, "severity": "WARNING"}

Check notice on line 1 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L1

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 1, "column": 35}}}, "severity": "INFO"}

Check notice on line 1 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L1

[Google.Passive] In general, use active voice instead of passive voice ('be referenced').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be referenced').", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 1, "column": 35}}}, "severity": "INFO"}

Check failure on line 1 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L1

[Vale.Spelling] Did you really mean 'pixmap'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixmap'?", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 1, "column": 52}}}, "severity": "ERROR"}

Write the documentation content for color_table table here.
## Use Cases

Check warning on line 3 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L3

[Google.Headings] 'Use Cases' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Use Cases' should use sentence-style capitalization.", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 3, "column": 4}}}, "severity": "WARNING"}

- **Pixmap palettes** - When linked to a Pixmap Table, provides the color palette for indexed pixel data.

Check failure on line 5 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L5

[Vale.Spelling] Did you really mean 'Pixmap'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Pixmap'?", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 5, "column": 5}}}, "severity": "ERROR"}

Check failure on line 5 in snippets/color_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/brief.md#L5

[Vale.Spelling] Did you really mean 'Pixmap'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Pixmap'?", "location": {"path": "snippets/color_table/brief.md", "range": {"start": {"line": 5, "column": 42}}}, "severity": "ERROR"}
- **Color storage** - Can store color sets independently for other purposes.
Comment on lines +1 to +6
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Address Vale spelling failures for pixmap/Pixmap in brief content.

This file currently fails lint. Please use lint-approved wording (or the project’s accepted glossary form) so docs checks pass.

🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

[error] 1-1: Vale.Spelling: Did you really mean 'pixmap'?


[error] 5-5: Vale.Spelling: Did you really mean 'Pixmap'?


[error] 5-5: Vale.Spelling: Did you really mean 'Pixmap'?

🪛 GitHub Actions: vale / vale

[error] 1-1: [Vale.Spelling] Did you really mean 'pixmap'?


[error] 5-5: [Vale.Spelling] Did you really mean 'Pixmap'?


[error] 5-5: [Vale.Spelling] Did you really mean 'Pixmap'?

🪛 GitHub Check: vale

[notice] 1-1: [vale] snippets/color_table/brief.md#L1
[Google.Acronyms] Spell out 'RGBA', if it's unfamiliar to the audience.


[warning] 1-1: [vale] snippets/color_table/brief.md#L1
[write-good.Passive] 'be referenced' may be passive voice. Use active voice if you can.


[notice] 1-1: [vale] snippets/color_table/brief.md#L1
[write-good.E-Prime] Try to avoid using 'be'.


[notice] 1-1: [vale] snippets/color_table/brief.md#L1
[Google.Passive] In general, use active voice instead of passive voice ('be referenced').


[failure] 1-1: [vale] snippets/color_table/brief.md#L1
[Vale.Spelling] Did you really mean 'pixmap'?


[warning] 3-3: [vale] snippets/color_table/brief.md#L3
[Google.Headings] 'Use Cases' should use sentence-style capitalization.


[failure] 5-5: [vale] snippets/color_table/brief.md#L5
[Vale.Spelling] Did you really mean 'Pixmap'?


[failure] 5-5: [vale] snippets/color_table/brief.md#L5
[Vale.Spelling] Did you really mean 'Pixmap'?

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@snippets/color_table/brief.md` around lines 1 - 6, The brief uses
non-conforming casing for the term "pixmap"/"Pixmap"; update all occurrences in
this file to the project's accepted glossary form (use "pixmap" consistently) so
lint (Vale) passes; edit the lines in the description and list items that
reference Pixmap Table or pixmap palettes to use "pixmap" lowercase and ensure
surrounding phrasing remains grammatical.

3 changes: 0 additions & 3 deletions snippets/color_table/configurations/brief/constant_alpha.md
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# constant_alpha

Write the documentation content for constant_alpha here.
Empty file.
Empty file.
3 changes: 3 additions & 0 deletions snippets/color_table/records/condition/alpha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# alpha

Check warning on line 1 in snippets/color_table/records/condition/alpha.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/records/condition/alpha.md#L1

[Google.Headings] 'alpha' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'alpha' should use sentence-style capitalization.", "location": {"path": "snippets/color_table/records/condition/alpha.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for alpha here.
3 changes: 3 additions & 0 deletions snippets/color_table/records/condition/blue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# blue

Check warning on line 1 in snippets/color_table/records/condition/blue.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/records/condition/blue.md#L1

[Google.Headings] 'blue' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'blue' should use sentence-style capitalization.", "location": {"path": "snippets/color_table/records/condition/blue.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for blue here.
3 changes: 3 additions & 0 deletions snippets/color_table/records/condition/color_type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# color_type

Check failure on line 1 in snippets/color_table/records/condition/color_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/records/condition/color_type.md#L1

[Vale.Spelling] Did you really mean 'color_type'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'color_type'?", "location": {"path": "snippets/color_table/records/condition/color_type.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/color_table/records/condition/color_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/records/condition/color_type.md#L1

[Google.Headings] 'color_type' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'color_type' should use sentence-style capitalization.", "location": {"path": "snippets/color_table/records/condition/color_type.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for color_type here.

Check failure on line 3 in snippets/color_table/records/condition/color_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/records/condition/color_type.md#L3

[Vale.Spelling] Did you really mean 'color_type'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'color_type'?", "location": {"path": "snippets/color_table/records/condition/color_type.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Comment on lines +1 to +3
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Replace underscore identifier prose to pass Vale (color_type).

This file fails lint on color_type. Use human-readable text (e.g., “color type”) in heading/body while keeping schema identifiers in backticks only where necessary.

🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

[error] 1-1: Vale.Spelling: Did you really mean 'color_type'?


[error] 3-3: Vale.Spelling: Did you really mean 'color_type'?

🪛 GitHub Actions: vale / vale

[error] 1-1: [Vale.Spelling] Did you really mean 'color_type'?


[error] 3-3: [Vale.Spelling] Did you really mean 'color_type'?

🪛 GitHub Check: vale

[failure] 1-1: [vale] snippets/color_table/records/condition/color_type.md#L1
[Vale.Spelling] Did you really mean 'color_type'?


[warning] 1-1: [vale] snippets/color_table/records/condition/color_type.md#L1
[Google.Headings] 'color_type' should use sentence-style capitalization.


[failure] 3-3: [vale] snippets/color_table/records/condition/color_type.md#L3
[Vale.Spelling] Did you really mean 'color_type'?

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@snippets/color_table/records/condition/color_type.md` around lines 1 - 3,
Update the documentation so the heading and prose use human-readable text
instead of the underscored identifier: change the heading from "# color_type" to
something like "# Color type" and replace occurrences of plain `color_type` in
the body with human-readable phrases such as "color type", reserving the
backticked `color_type` only when referencing the exact schema identifier or
code example; ensure the file still documents the schema named `color_type` but
uses natural language for headings and explanatory sentences.

3 changes: 3 additions & 0 deletions snippets/color_table/records/condition/green.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# green

Check warning on line 1 in snippets/color_table/records/condition/green.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/records/condition/green.md#L1

[Google.Headings] 'green' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'green' should use sentence-style capitalization.", "location": {"path": "snippets/color_table/records/condition/green.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for green here.
3 changes: 3 additions & 0 deletions snippets/color_table/records/condition/red.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# red

Check warning on line 1 in snippets/color_table/records/condition/red.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/records/condition/red.md#L1

[Google.Headings] 'red' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'red' should use sentence-style capitalization.", "location": {"path": "snippets/color_table/records/condition/red.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for red here.
Empty file.
Empty file.
3 changes: 3 additions & 0 deletions snippets/font_table/records/condition/author.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# author

Check warning on line 1 in snippets/font_table/records/condition/author.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/author.md#L1

[Google.Headings] 'author' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'author' should use sentence-style capitalization.", "location": {"path": "snippets/font_table/records/condition/author.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for author here.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# character_table_indexes

Check failure on line 1 in snippets/font_table/records/condition/character_table_indexes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/character_table_indexes.md#L1

[Vale.Spelling] Did you really mean 'character_table_indexes'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'character_table_indexes'?", "location": {"path": "snippets/font_table/records/condition/character_table_indexes.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/font_table/records/condition/character_table_indexes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/character_table_indexes.md#L1

[Google.Headings] 'character_table_indexes' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'character_table_indexes' should use sentence-style capitalization.", "location": {"path": "snippets/font_table/records/condition/character_table_indexes.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for character_table_indexes here.

Check failure on line 3 in snippets/font_table/records/condition/character_table_indexes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/character_table_indexes.md#L3

[Vale.Spelling] Did you really mean 'character_table_indexes'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'character_table_indexes'?", "location": {"path": "snippets/font_table/records/condition/character_table_indexes.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Comment on lines +1 to +3
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix Vale spelling failures in heading/body token usage (Line 1, Line 3).

character_table_indexes is currently triggering pipeline errors. Use sentence-style heading text and reference the identifier as inline code in prose to satisfy Vale while keeping the exact field name.

Suggested patch
-# character_table_indexes
+# Character table indexes
 
-Write the documentation content for character_table_indexes here.
+Write the documentation content for `character_table_indexes` here.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# character_table_indexes
Write the documentation content for character_table_indexes here.
# Character table indexes
Write the documentation content for `character_table_indexes` here.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

[error] 1-1: Vale.Spelling: Did you really mean 'character_table_indexes'?


[error] 3-3: Vale.Spelling: Did you really mean 'character_table_indexes'?

🪛 GitHub Check: vale

[failure] 1-1: [vale] snippets/font_table/records/condition/character_table_indexes.md#L1
[Vale.Spelling] Did you really mean 'character_table_indexes'?


[warning] 1-1: [vale] snippets/font_table/records/condition/character_table_indexes.md#L1
[Google.Headings] 'character_table_indexes' should use sentence-style capitalization.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@snippets/font_table/records/condition/character_table_indexes.md` around
lines 1 - 3, Change the Markdown heading to sentence-style text and mention the
field name as inline code in the body: replace the all-lowercase heading
"character_table_indexes" with a sentence-style heading (e.g., "Character table
indexes") and update the body to refer to the identifier as
`character_table_indexes` within prose so Vale accepts heading/body token usage
while preserving the exact field name.

3 changes: 3 additions & 0 deletions snippets/font_table/records/condition/font_type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# font_type

Check failure on line 1 in snippets/font_table/records/condition/font_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/font_type.md#L1

[Vale.Spelling] Did you really mean 'font_type'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'font_type'?", "location": {"path": "snippets/font_table/records/condition/font_type.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/font_table/records/condition/font_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/font_type.md#L1

[Google.Headings] 'font_type' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'font_type' should use sentence-style capitalization.", "location": {"path": "snippets/font_table/records/condition/font_type.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for font_type here.

Check failure on line 3 in snippets/font_table/records/condition/font_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/font_type.md#L3

[Vale.Spelling] Did you really mean 'font_type'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'font_type'?", "location": {"path": "snippets/font_table/records/condition/font_type.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Comment on lines +1 to +3
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Resolve CI-breaking spelling errors for font_type (Line 1, Line 3).

The raw underscored token is failing Vale in both the heading and body. Switch heading to sentence style and keep the exact identifier in inline code where needed.

Suggested patch
-# font_type
+# Font type
 
-Write the documentation content for font_type here.
+Write the documentation content for `font_type` here.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# font_type
Write the documentation content for font_type here.
# Font type
Write the documentation content for `font_type` here.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

[error] 1-1: Vale.Spelling: Did you really mean 'font_type'?


[error] 3-3: Vale.Spelling: Did you really mean 'font_type'?

🪛 GitHub Check: vale

[failure] 1-1: [vale] snippets/font_table/records/condition/font_type.md#L1
[Vale.Spelling] Did you really mean 'font_type'?


[warning] 1-1: [vale] snippets/font_table/records/condition/font_type.md#L1
[Google.Headings] 'font_type' should use sentence-style capitalization.


[failure] 3-3: [vale] snippets/font_table/records/condition/font_type.md#L3
[Vale.Spelling] Did you really mean 'font_type'?

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@snippets/font_table/records/condition/font_type.md` around lines 1 - 3, The
heading and body use a raw underscored token that fails Vale; change the heading
from the underscored markdown heading to sentence case (e.g., "Font type") and
rewrite the body sentence to use normal sentence style while keeping the exact
identifier as inline code (`font_type`) where referenced; update the first line
to a sentence-style heading and replace the body line "Write the documentation
content for font_type here." with a proper sentence that refers to `font_type`
in backticks.

3 changes: 3 additions & 0 deletions snippets/font_table/records/condition/name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# name

Check warning on line 1 in snippets/font_table/records/condition/name.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/name.md#L1

[Google.Headings] 'name' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'name' should use sentence-style capitalization.", "location": {"path": "snippets/font_table/records/condition/name.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for name here.
3 changes: 3 additions & 0 deletions snippets/font_table/records/condition/version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# version

Check warning on line 1 in snippets/font_table/records/condition/version.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/records/condition/version.md#L1

[Google.Headings] 'version' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'version' should use sentence-style capitalization.", "location": {"path": "snippets/font_table/records/condition/version.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for version here.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# constant_bits_per_pixel

Check failure on line 1 in snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md#L1

[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md#L1

[Google.Headings] 'constant_bits_per_pixel' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'constant_bits_per_pixel' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for constant_bits_per_pixel here.

Check failure on line 3 in snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md#L3

[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# constant_height

Check failure on line 1 in snippets/pixmap_table/configurations/condition/constant_height.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_height.md#L1

[Vale.Spelling] Did you really mean 'constant_height'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_height'?", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_height.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/pixmap_table/configurations/condition/constant_height.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_height.md#L1

[Google.Headings] 'constant_height' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'constant_height' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_height.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for constant_height here.

Check failure on line 3 in snippets/pixmap_table/configurations/condition/constant_height.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_height.md#L3

[Vale.Spelling] Did you really mean 'constant_height'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_height'?", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_height.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# constant_width

Check failure on line 1 in snippets/pixmap_table/configurations/condition/constant_width.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_width.md#L1

[Vale.Spelling] Did you really mean 'constant_width'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_width'?", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_width.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/pixmap_table/configurations/condition/constant_width.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_width.md#L1

[Google.Headings] 'constant_width' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'constant_width' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_width.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for constant_width here.

Check failure on line 3 in snippets/pixmap_table/configurations/condition/constant_width.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/condition/constant_width.md#L3

[Vale.Spelling] Did you really mean 'constant_width'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_width'?", "location": {"path": "snippets/pixmap_table/configurations/condition/constant_width.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# constant_bits_per_pixel

Check failure on line 1 in snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1

[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1

[Google.Headings] 'constant_bits_per_pixel' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'constant_bits_per_pixel' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for constant_bits_per_pixel here.

Check failure on line 3 in snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L3

[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_bits_per_pixel'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# constant_height

Check warning on line 1 in snippets/pixmap_table/configurations/flag/use_constant_height.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_height.md#L1

[Google.Headings] 'constant_height' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'constant_height' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_height.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Check failure on line 1 in snippets/pixmap_table/configurations/flag/use_constant_height.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_height.md#L1

[Vale.Spelling] Did you really mean 'constant_height'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_height'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_height.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Write the documentation content for constant_height here.

Check failure on line 3 in snippets/pixmap_table/configurations/flag/use_constant_height.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_height.md#L3

[Vale.Spelling] Did you really mean 'constant_height'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_height'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_height.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# constant_width

Check failure on line 1 in snippets/pixmap_table/configurations/flag/use_constant_width.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_width.md#L1

[Vale.Spelling] Did you really mean 'constant_width'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_width'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_width.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/pixmap_table/configurations/flag/use_constant_width.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_width.md#L1

[Google.Headings] 'constant_width' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'constant_width' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_width.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for constant_width here.

Check failure on line 3 in snippets/pixmap_table/configurations/flag/use_constant_width.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/configurations/flag/use_constant_width.md#L3

[Vale.Spelling] Did you really mean 'constant_width'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'constant_width'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_width.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
Empty file.
Empty file.
3 changes: 3 additions & 0 deletions snippets/pixmap_table/records/condition/bits_per_pixel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# bits_per_pixel

Check failure on line 1 in snippets/pixmap_table/records/condition/bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/records/condition/bits_per_pixel.md#L1

[Vale.Spelling] Did you really mean 'bits_per_pixel'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'bits_per_pixel'?", "location": {"path": "snippets/pixmap_table/records/condition/bits_per_pixel.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check warning on line 1 in snippets/pixmap_table/records/condition/bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/records/condition/bits_per_pixel.md#L1

[Google.Headings] 'bits_per_pixel' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'bits_per_pixel' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/records/condition/bits_per_pixel.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for bits_per_pixel here.

Check failure on line 3 in snippets/pixmap_table/records/condition/bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/records/condition/bits_per_pixel.md#L3

[Vale.Spelling] Did you really mean 'bits_per_pixel'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'bits_per_pixel'?", "location": {"path": "snippets/pixmap_table/records/condition/bits_per_pixel.md", "range": {"start": {"line": 3, "column": 37}}}, "severity": "ERROR"}
3 changes: 3 additions & 0 deletions snippets/pixmap_table/records/condition/data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# data

Check warning on line 1 in snippets/pixmap_table/records/condition/data.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/records/condition/data.md#L1

[Google.Headings] 'data' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'data' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/records/condition/data.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for data here.
3 changes: 3 additions & 0 deletions snippets/pixmap_table/records/condition/height.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# height

Check warning on line 1 in snippets/pixmap_table/records/condition/height.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/records/condition/height.md#L1

[Google.Headings] 'height' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'height' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/records/condition/height.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for height here.
3 changes: 3 additions & 0 deletions snippets/pixmap_table/records/condition/width.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# width

Check warning on line 1 in snippets/pixmap_table/records/condition/width.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/records/condition/width.md#L1

[Google.Headings] 'width' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'width' should use sentence-style capitalization.", "location": {"path": "snippets/pixmap_table/records/condition/width.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Write the documentation content for width here.
8 changes: 4 additions & 4 deletions src/Character Table.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@

| Bit | Name | Description |
| --- | ------------------------------ | --------------------------------------------------------------- |
| 0 | `use_constant_codepoint_count` | \textinput{../snippets/character_table/configurations/flag/use_constant_codepoint_count.md} |
| 0 | `use_constant_code_point_count` | \textinput{../snippets/character_table/configurations/flag/use_constant_code_point_count.md} |
| 1-7 | — | \textinput{../snippets/phrase/reserved.md} |

#### Configuration Values

| Name | Type | Condition | Description |
| -------------------------- | ---- | -------------------------------------------- | ------------------------------------------------------------------- |
| `constant_codepoint_count` | `u8` | \textinput{../snippets/character_table/configurations/condition/constant_codepoint_count.md} | \textinput{../snippets/character_table/configurations/brief/constant_codepoint_count.md} |
| `constant_code_point_count` | `u8` | \textinput{../snippets/character_table/configurations/condition/constant_code_point_count.md} | \textinput{../snippets/character_table/configurations/brief/constant_code_point_count.md} |

### Table Links

Expand All @@ -54,8 +54,8 @@ Each character record contains the following fields in order:
| -------------------- | -------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `advance_x` | `u8` | \textinput{../snippets/character_table/records/condition/advance_x.md} | \textinput{../snippets/character_table/records/brief/advance_x.md} |
| `pixmap_index` | `u8` | \textinput{../snippets/character_table/records/condition/pixmap_index.md} | \textinput{../snippets/character_table/records/brief/pixmap_index.md} |
| `pixmap_table_index` | `Index<PixmapTable>` | \textinput{../snippets/character_table/records/condition/pixmap_table_index.md} | \textinput{../snippets/character_table/records/brief/pixmap_table_index.md} |
| `codepoints` | `str` | \textinput{../snippets/character_table/records/condition/codepoints.md} | \textinput{../snippets/character_table/records/brief/codepoints.md} |
| `pixmap_table_index` | `u8` | \textinput{../snippets/character_table/records/condition/pixmap_table_index.md} | \textinput{../snippets/character_table/records/brief/pixmap_table_index.md} |
| `code_points` | `String` | \textinput{../snippets/character_table/records/condition/code_points.md} | \textinput{../snippets/character_table/records/brief/codepoints.md} |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify both possible brief snippet filenames and all references.
fd -i 'code_points.md|codepoints.md' snippets/character_table/records/brief snippets/character_table/records/condition
rg -n 'records/(brief|condition)/(code_points|codepoints)\.md' src snippets

Repository: SimplePixelFont/Specification

Length of output: 408


🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Confirm whether the mistakenly referenced file exists anywhere.
echo "== Files named codepoints.md under character_table snippets =="
fd -i 'codepoints\.md$' snippets/character_table/records/brief snippets/character_table/records/condition snippets/character_table/records || true

echo "== Any codepoints.md references in src =="
rg -n 'snippets/character_table/records/brief/codepoints\.md' src || true

echo "== Any codepoints.md filename references in src/snippets =="
rg -n 'codepoints\.md' src snippets || true

Repository: SimplePixelFont/Specification

Length of output: 684


Fix snippet include path mismatch for code_points (Line 58).

src/Character Table.md line 58 references \textinput{../snippets/character_table/records/brief/codepoints.md}, but the actual file is snippets/character_table/records/brief/code_points.md (no brief/codepoints.md exists), which will break generation.

| `code_points`         | `String`                | \textinput{../snippets/character_table/records/condition/code_points.md} | \textinput{../snippets/character_table/records/brief/codepoints.md} |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/Character` Table.md at line 58, The table row for the `code_points` field
uses a wrong snippet include path
`\textinput{../snippets/character_table/records/brief/codepoints.md}` which
doesn't exist; update that include to the correct filename
`\textinput{../snippets/character_table/records/brief/code_points.md}` in the
`code_points` table row so the brief snippet matches the actual `code_points.md`
file.


### Record Layout Examples

Expand Down
70 changes: 70 additions & 0 deletions src/Color Table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
\textinput{../snippets/color_table/brief.md}

## Table Structure

Check warning on line 3 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L3

[Google.Headings] 'Table Structure' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Table Structure' should use sentence-style capitalization.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 3, "column": 4}}}, "severity": "WARNING"}

### Identifier
- **Value**: `0x03`


## Modifier Flags

Check warning on line 9 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L9

[Google.Headings] 'Modifier Flags' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Modifier Flags' should use sentence-style capitalization.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 9, "column": 4}}}, "severity": "WARNING"}

| Bit | Name | Description |
| --- | ---- | ----------- |
| 0 | `use_color_type` | \textinput{../snippets/color_table/modifiers/brief/use_color_type.md} |
| 1-7 | — | \textinput{../snippets/phrase/reserved.md} |

### Flag Details

Check warning on line 16 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L16

[Google.Headings] 'Flag Details' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Flag Details' should use sentence-style capitalization.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 16, "column": 5}}}, "severity": "WARNING"}

- **`use_color_type`**: \textinput{../snippets/color_table/modifiers/details/use_color_type.md}

## Configuration Flags

Check warning on line 20 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L20

[Google.Headings] 'Configuration Flags' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Configuration Flags' should use sentence-style capitalization.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 20, "column": 4}}}, "severity": "WARNING"}

| Bit | Name | Description |
| --- | ---- | ----------- |
| 0 | `use_constant_alpha` | \textinput{../snippets/color_table/configurations/flag/use_constant_alpha.md} |
| 1-7 | — | \textinput{../snippets/phrase/reserved.md} |

### Configuration Values

Check warning on line 27 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L27

[Google.Headings] 'Configuration Values' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Configuration Values' should use sentence-style capitalization.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 27, "column": 5}}}, "severity": "WARNING"}

| Name | Type | Condition | Description |
| ---- | ---- | --------- | ----------- |
| `constant_alpha` | `u8` | \textinput{../snippets/color_table/configurations/condition/constant_alpha.md} | \textinput{../snippets/color_table/configurations/brief/constant_alpha.md} |

## Record Fields

Check warning on line 33 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L33

[Google.Headings] 'Record Fields' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Record Fields' should use sentence-style capitalization.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 33, "column": 4}}}, "severity": "WARNING"}


Each record contains the following fields in order:

| Field | Type | Condition | Description |
| ----- | ---- | --------- | ----------- |
| `color_type` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/color_type.md} | \textinput{../snippets/color_table/records/brief/color_type.md} |
| `alpha` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/alpha.md} | \textinput{../snippets/color_table/records/brief/alpha.md} |
| `red` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/red.md} | \textinput{../snippets/color_table/records/brief/red.md} |
| `green` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/green.md} | \textinput{../snippets/color_table/records/brief/green.md} |
| `blue` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/blue.md} | \textinput{../snippets/color_table/records/brief/blue.md} |

## Examples


Provide example records demonstrating various field combinations:

Check warning on line 49 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L49

[write-good.Weasel] 'various' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'various' is a weasel word!", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 49, "column": 39}}}, "severity": "WARNING"}

**Example 1: Minimal record** (no optional fields)

Check warning on line 51 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L51

[Google.Colons] ': M' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': M' should be in lowercase.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 51, "column": 12}}}, "severity": "WARNING"}

Check notice on line 51 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L51

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 51, "column": 31}}}, "severity": "INFO"}
```
[EXAMPLE_PLACEHOLDER]
```

**Example 2: With optional fields**

Check warning on line 56 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L56

[Google.Colons] ': W' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': W' should be in lowercase.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 56, "column": 12}}}, "severity": "WARNING"}
```
[EXAMPLE_PLACEHOLDER]
Comment on lines +52 to +58
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language tags to fenced code blocks (Line 52, Line 57).

This removes markdownlint warnings and keeps docs tooling clean.

Suggested patch
-```
+```text
 [EXAMPLE_PLACEHOLDER]

...
- +text
[EXAMPLE_PLACEHOLDER]

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 52-52: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


[warning] 57-57: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/Color` Table.md around lines 52 - 58, Add a language tag to both fenced
code blocks containing "[EXAMPLE_PLACEHOLDER]" so markdownlint stops warning:
replace the opening ``` with ```text for the code block under the "Example 2:
With optional fields" section and the earlier example block (the two occurrences
of "[EXAMPLE_PLACEHOLDER]" around lines 52 and 57) so both fenced blocks become
```text ... ```; no other changes needed.

```


## Complete Table Example

Check warning on line 62 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L62

[Google.Headings] 'Complete Table Example' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Complete Table Example' should use sentence-style capitalization.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 62, "column": 4}}}, "severity": "WARNING"}


The following byte sequence defines a minimal table with example records:

| Byte(s) | Binary | Hex | Description |

Check failure on line 67 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L67

[Google.OptionalPlurals] Don't use plurals in parentheses such as in 'Byte(s)'.
Raw output
{"message": "[Google.OptionalPlurals] Don't use plurals in parentheses such as in 'Byte(s)'.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 67, "column": 3}}}, "severity": "ERROR"}

Check notice on line 67 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L67

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 67, "column": 7}}}, "severity": "INFO"}
| ------- | ------ | --- | ----------- |
| 1 | `[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | Table identifier |
| ... | ... | ... | [DESCRIPTION_PLACEHOLDER] |

Check warning on line 70 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L70

[Google.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[Google.Ellipses] In general, don't use an ellipsis.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 70, "column": 3}}}, "severity": "WARNING"}

Check failure on line 70 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L70

[proselint.Typography] Consider using the '…' symbol instead of '...'.
Raw output
{"message": "[proselint.Typography] Consider using the '…' symbol instead of '...'.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 70, "column": 3}}}, "severity": "ERROR"}

Check failure on line 70 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L70

[proselint.Typography] Consider using the '…' symbol instead of '...'.
Raw output
{"message": "[proselint.Typography] Consider using the '…' symbol instead of '...'.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 70, "column": 9}}}, "severity": "ERROR"}

Check warning on line 70 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L70

[Google.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[Google.Ellipses] In general, don't use an ellipsis.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 70, "column": 9}}}, "severity": "WARNING"}

Check failure on line 70 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L70

[proselint.Typography] Consider using the '…' symbol instead of '...'.
Raw output
{"message": "[proselint.Typography] Consider using the '…' symbol instead of '...'.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 70, "column": 15}}}, "severity": "ERROR"}

Check warning on line 70 in src/Color Table.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/Color Table.md#L70

[Google.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[Google.Ellipses] In general, don't use an ellipsis.", "location": {"path": "src/Color Table.md", "range": {"start": {"line": 70, "column": 15}}}, "severity": "WARNING"}
Comment on lines +67 to +70
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix Vale failures in the table example header/text (Line 67, Line 70).

Current wording is failing CI: Byte(s) and .... Replace with lint-compliant phrasing.

Suggested patch
-| Byte(s) | Binary | Hex | Description |
+| Bytes | Binary | Hex | Description |
 ...
-| ... | ... | ... | [DESCRIPTION_PLACEHOLDER] |
+| … | … | … | [DESCRIPTION_PLACEHOLDER] |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Byte(s) | Binary | Hex | Description |
| ------- | ------ | --- | ----------- |
| 1 | `[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | Table identifier |
| ... | ... | ... | [DESCRIPTION_PLACEHOLDER] |
| Bytes | Binary | Hex | Description |
| ------- | ------ | --- | ----------- |
| 1 | `[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | Table identifier |
| | | | [DESCRIPTION_PLACEHOLDER] |
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

[error] 67-67: Google.OptionalPlurals: Don't use plurals in parentheses such as in 'Byte(s)'.


[error] 70-70: proselint.Typography: Consider using the '…' symbol instead of '...'.

🪛 GitHub Actions: vale / vale

[error] 67-67: [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'Byte(s)'.


[error] 70-70: [proselint.Typography] Consider using the '…' symbol instead of '...'.


[error] 70-70: [proselint.Typography] Consider using the '…' symbol instead of '...'.


[error] 70-70: [proselint.Typography] Consider using the '…' symbol instead of '...'.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/Color` Table.md around lines 67 - 70, Replace the lint-violating header
text "Byte(s)" with "Bytes" in the table header and replace the literal "..."
cells in the second row with lint-compliant phrasing such as "Additional rows"
(for the Byte(s)/Bytes column) and "Other entries" or "More values" as
appropriate; also keep the placeholder tokens `[BINARY_PLACEHOLDER]`,
`[HEX_PLACEHOLDER]`, and `[DESCRIPTION_PLACEHOLDER]` intact but ensure their
surrounding cell text is updated so the row reads like: Bytes |
`[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | `[DESCRIPTION_PLACEHOLDER]` with
the second-row first cell using "Additional rows" instead of "...".

Loading
Loading