Skip to content

Update Specifications #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
The-Nice-One merged 26 commits into from
Jul 25, 2026
Merged

Update Specifications #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ff56ff5
Change to active voice
The-Nice-One May 29, 2026
656077e
Add missing snippet files and polish field names
The-Nice-One Jun 5, 2026
c38768d
Allow running workflow in documentation branch for debugging.
The-Nice-One Jun 11, 2026
42fdd28
Fix relative markdown links in Character Table
The-Nice-One Jun 11, 2026
e4ba5c3
Fix markdown inclusion path
The-Nice-One Jun 11, 2026
cfb2179
Fix tooling to output correct paths for table link flags
The-Nice-One Jun 11, 2026
ce4a064
Fix remaining out-dated field names in Character Table document.
The-Nice-One Jun 11, 2026
5093cd0
Add Color Table documentation
The-Nice-One Jun 11, 2026
e9f43de
Update Record Examples generated header
The-Nice-One Jun 11, 2026
0f9204e
Add Pixmap Table (incomplete).
The-Nice-One Jun 11, 2026
4d59eae
Polish character, color, and pixmap documents
The-Nice-One Jul 25, 2026
2f152b9
Replace type placeholders for Pixmap and Color Table docuemnts
The-Nice-One Jul 25, 2026
4622fa8
remove trailing newline in snippets
The-Nice-One Jul 25, 2026
bc7539b
remove trailing newline in missed snippet
The-Nice-One Jul 25, 2026
cf12fd9
Add Font table document and snippets
The-Nice-One Jul 25, 2026
5b80562
Readd old documents
The-Nice-One Jul 25, 2026
408e337
Edit Font Table.md to trigger sync
The-Nice-One Jul 25, 2026
fa88281
Edit Font Table.md to fix path error
The-Nice-One Jul 25, 2026
1c03eaa
Fix all vale errors
The-Nice-One Jul 25, 2026
933d611
Fix ambiguity in Font Table record examples
The-Nice-One Jul 25, 2026
55c9d18
Remove documentation branch from triggering wiki workflow
The-Nice-One Jul 25, 2026
6f9a91b
Merge branch 'main' into documentation
The-Nice-One Jul 25, 2026
b45c08b
Update Vocab setting in .vale.ini
The-Nice-One Jul 25, 2026
11e62bf
Prevent proselint documents from generating errors.
The-Nice-One Jul 25, 2026
1642b37
Add pixmaps to vale vocab
The-Nice-One Jul 25, 2026
360072b
Some fixes in snippets
The-Nice-One Jul 25, 2026
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
2 changes: 2 additions & 0 deletions .ci/styles/config/vocabularies/SimplePixelFont/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
(?i)pixmap
(?i)pixmaps
Empty file removed .ci/styles/txt
View file
Open in desktop
Empty file.
4 changes: 2 additions & 2 deletions .github/workflows/wiki.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ jobs:
steps:
- name: Checkout Repo
uses: actions/checkout@v2

- name: Process markdown files
run: npx https://github.com/The-Nice-One/rail-yard.git preprocess -i ./src -o ./build

- name: Sync docs to wiki
uses: newrelic/wiki-sync-action@main
with:
Expand Down
7 changes: 5 additions & 2 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
StylesPath = .ci/styles

Vocab = SimplePixelFont
Packages = Google, write-good, proselint

[.ci/styles/proselint/*.md]
BasedOnStyles =

[*.md]
BasedOnStyles = Vale, Google, write-good, proselint
BasedOnStyles = Vale, Google, write-good, proselint
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
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
18 changes: 12 additions & 6 deletions scripts/snippet-tool.ts
View file
Open in desktop
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}`);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
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 @@ -281,7 +286,7 @@ function generateLinksSection(
const linkBriefName = links[i]; // e.g., "pixmap_tables"
const flagName = "link_" + linkBriefName; // e.g., "link_pixmap_tables"
// Note: Template shows looking in condition directory for the flag description
const flagPath = getRelativeSnippetPath(snippetType, "links/condition", flagName);
const flagPath = getRelativeSnippetPath(snippetType, "links/flag", flagName);
lines.push(
`| ${i} | \`${flagName}\` | \\textinput{${flagPath}} |`
);
Expand Down Expand Up @@ -337,7 +342,7 @@ function generateRecordsSection(
function generateExamplesSection(tableName: string): string {
const lines: string[] = [];

lines.push(addTableHeader("Examples\n"));
lines.push(addTableHeader("Record Layout Examples\n"));
lines.push(
"Provide example records demonstrating various field combinations:\n"
);
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
1 change: 1 addition & 0 deletions snippets/character_table/configurations/brief/constant_code_point_count.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The exact code point length of each `code_points` field in this table
1 change: 0 additions & 1 deletion snippets/character_table/configurations/brief/constant_codepoint_count.md
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions snippets/character_table/configurations/condition/constant_code_point_count.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_code_point_count` is enabled.

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"}

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"}
1 change: 0 additions & 1 deletion snippets/character_table/configurations/condition/constant_codepoint_count.md
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions snippets/character_table/configurations/flag/use_constant_code_point_count.md
View file
Open in desktop
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.
1 change: 0 additions & 1 deletion snippets/character_table/configurations/flag/use_constant_codepoint_count.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion snippets/character_table/links/brief/pixmap_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Vector of Pixmap Table indices this character table references.
Length byte followed by that many Pixmap Table indices this character table may reference.
2 changes: 1 addition & 1 deletion snippets/character_table/modifiers/details/use_pixmap_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
When disabled, the pixmap index defaults to match the character record index (1:1 mapping).
When disabled, the pixmap index defaults to match the character record index creating a one to one mapping.

Check warning on line 1 in snippets/character_table/modifiers/details/use_pixmap_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/modifiers/details/use_pixmap_index.md#L1 

[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.
Raw output 
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.", "location": {"path": "snippets/character_table/modifiers/details/use_pixmap_index.md", "range": {"start": {"line": 1, "column": 6}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/character_table/records/brief/code_points.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
UTF-8 encoded code point sequence, null-terminated unless `constant_code_point_count` is set.

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/brief/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/brief/code_points.md", "range": {"start": {"line": 1, "column": 87}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/brief/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/brief/code_points.md", "range": {"start": {"line": 1, "column": 87}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/brief/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/brief/code_points.md", "range": {"start": {"line": 1, "column": 87}}}, "severity": "WARNING"}
2 changes: 1 addition & 1 deletion snippets/character_table/records/brief/pixmap_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
If `use_pixmap_index` modifier is enabled.
Index of the pixmap within the referenced Pixmap Tables.
2 changes: 1 addition & 1 deletion snippets/character_table/records/brief/pixmap_table_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
If `use_pixmap_table_index` modifier is enabled.
Index of the specific Pixmap Table to use for this character.
0 ...aracter_table/records/brief/codepoints.md → ...er_table/records/condition/code_points.md
View file
Open in desktop
File renamed without changes.
1 change: 0 additions & 1 deletion snippets/character_table/records/condition/codepoints.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion snippets/character_table/records/condition/pixmap_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Index of the pixmap within the referenced Pixmap Table(s).
If `use_pixmap_index` modifier is enabled.

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/pixmap_index.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/pixmap_index.md", "range": {"start": {"line": 1, "column": 32}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/pixmap_index.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/records/condition/pixmap_index.md", "range": {"start": {"line": 1, "column": 32}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/pixmap_index.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/records/condition/pixmap_index.md", "range": {"start": {"line": 1, "column": 32}}}, "severity": "WARNING"}
2 changes: 1 addition & 1 deletion snippets/character_table/records/condition/pixmap_table_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Index of the specific Pixmap Table to use for this character.
If `use_pixmap_table_index` modifier is enabled.

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/pixmap_table_index.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/records/condition/pixmap_table_index.md", "range": {"start": {"line": 1, "column": 38}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/pixmap_table_index.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/records/condition/pixmap_table_index.md", "range": {"start": {"line": 1, "column": 38}}}, "severity": "WARNING"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/character_table/records/condition/pixmap_table_index.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/pixmap_table_index.md", "range": {"start": {"line": 1, "column": 38}}}, "severity": "INFO"}
7 changes: 5 additions & 2 deletions snippets/color_table/brief.md
View file
Open in desktop
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 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 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"}

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.
- **Color storage** - Can store color sets independently for other purposes.
Comment on lines +1 to +6

@coderabbitai coderabbitai Bot Jun 5, 2026

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.

4 changes: 1 addition & 3 deletions snippets/color_table/configurations/brief/constant_alpha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# constant_alpha

Write the documentation content for constant_alpha here.
The alpha channel value applied to all colors in this table.
1 change: 1 addition & 0 deletions snippets/color_table/configurations/condition/constant_alpha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_alpha` is enabled.

Check notice on line 1 in snippets/color_table/configurations/condition/constant_alpha.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/configurations/condition/constant_alpha.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/color_table/configurations/condition/constant_alpha.md", "range": {"start": {"line": 1, "column": 25}}}, "severity": "INFO"}

Check notice on line 1 in snippets/color_table/configurations/condition/constant_alpha.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/configurations/condition/constant_alpha.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/color_table/configurations/condition/constant_alpha.md", "range": {"start": {"line": 1, "column": 25}}}, "severity": "INFO"}

Check warning on line 1 in snippets/color_table/configurations/condition/constant_alpha.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/configurations/condition/constant_alpha.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/color_table/configurations/condition/constant_alpha.md", "range": {"start": {"line": 1, "column": 25}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/color_table/configurations/flag/use_constant_alpha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All colors in this table share the same alpha value.
4 changes: 1 addition & 3 deletions snippets/color_table/modifiers/brief/use_color_type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# use_color_type

Write the documentation content for use_color_type here.
Each record includes a `color_type` field indicating the color mutability type.
4 changes: 1 addition & 3 deletions snippets/color_table/modifiers/details/use_color_type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# use_color_type details

Write the documentation content for use_color_type details here.
When disabled, the default color type is dynamic. The rendering engine may change the RGBA color to support features such as, but not limited to; text color, and/or palette theming.

Check warning on line 1 in snippets/color_table/modifiers/details/use_color_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/modifiers/details/use_color_type.md#L1 

[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.
Raw output 
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.", "location": {"path": "snippets/color_table/modifiers/details/use_color_type.md", "range": {"start": {"line": 1, "column": 6}}}, "severity": "WARNING"}

Check notice on line 1 in snippets/color_table/modifiers/details/use_color_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/modifiers/details/use_color_type.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/color_table/modifiers/details/use_color_type.md", "range": {"start": {"line": 1, "column": 39}}}, "severity": "INFO"}

Check notice on line 1 in snippets/color_table/modifiers/details/use_color_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/modifiers/details/use_color_type.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/modifiers/details/use_color_type.md", "range": {"start": {"line": 1, "column": 87}}}, "severity": "INFO"}

Check notice on line 1 in snippets/color_table/modifiers/details/use_color_type.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/color_table/modifiers/details/use_color_type.md#L1 

[Google.Semicolons] Use semicolons judiciously.
Raw output 
{"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "snippets/color_table/modifiers/details/use_color_type.md", "range": {"start": {"line": 1, "column": 145}}}, "severity": "INFO"}

@coderabbitai coderabbitai Bot Jul 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Fix the punctuation in the “but not limited to” clause.

Use a colon or rewrite the sentence, for example: “The rendering engine may change the RGBA color for text-color changes and palette theming.”

🧰 Tools
🪛 GitHub Check: vale

[warning] 1-1: [vale] snippets/color_table/modifiers/details/use_color_type.md#L1
[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.

[notice] 1-1: [vale] snippets/color_table/modifiers/details/use_color_type.md#L1
[write-good.E-Prime] Try to avoid using 'is'.

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

[notice] 1-1: [vale] snippets/color_table/modifiers/details/use_color_type.md#L1
[Google.Semicolons] Use semicolons judiciously.

🤖 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/modifiers/details/use_color_type.md` at line 1, Fix the
punctuation and wording in the “but not limited to” sentence within the default
color type description, using a colon or the suggested rewrite while preserving
the original meaning.

Source: Linters/SAST tools

4 changes: 1 addition & 3 deletions snippets/color_table/records/brief/alpha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# alpha

Write the documentation content for alpha here.
Alpha channel value (0 = fully transparent, 255 = fully opaque).

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "snippets/color_table/records/brief/alpha.md", "range": {"start": {"line": 1, "column": 21}}}, "severity": "INFO"}
4 changes: 1 addition & 3 deletions snippets/color_table/records/brief/blue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# blue

Write the documentation content for blue here.
Blue channel value.
4 changes: 1 addition & 3 deletions snippets/color_table/records/brief/color_type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# color_type

Write the documentation content for color_type here.
Color Type value (0 = Dynamic, 1 = Absolute).

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "snippets/color_table/records/brief/color_type.md", "range": {"start": {"line": 1, "column": 18}}}, "severity": "INFO"}
4 changes: 1 addition & 3 deletions snippets/color_table/records/brief/green.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# green

Write the documentation content for green here.
Green channel value.
4 changes: 1 addition & 3 deletions snippets/color_table/records/brief/red.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# red

Write the documentation content for red here.
Red channel value.
1 change: 1 addition & 0 deletions snippets/color_table/records/condition/alpha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `constant_alpha` configuration is **not** set

Check notice 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.Contractions] Use 'isn't' instead of 'is not'.
Raw output 
{"message": "[Google.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "snippets/color_table/records/condition/alpha.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}

Check notice 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 

[write-good.E-Prime] Try to avoid using 'is'.
Raw output 
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "snippets/color_table/records/condition/alpha.md", "range": {"start": {"line": 1, "column": 35}}}, "severity": "INFO"}
1 change: 1 addition & 0 deletions snippets/color_table/records/condition/blue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present
1 change: 1 addition & 0 deletions snippets/color_table/records/condition/color_type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_color_type` modifier is enabled.

Check notice 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 

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

Check notice 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.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/color_table/records/condition/color_type.md", "range": {"start": {"line": 1, "column": 30}}}, "severity": "INFO"}

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 

[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/color_table/records/condition/color_type.md", "range": {"start": {"line": 1, "column": 30}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/color_table/records/condition/green.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present
1 change: 1 addition & 0 deletions snippets/color_table/records/condition/red.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present
8 changes: 5 additions & 3 deletions snippets/font_table/brief.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# font_table table

Write the documentation content for font_table table here.
Groups Character Tables into named fonts and carries the metadata to identify them.

## Use Cases

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_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/font_table/brief.md", "range": {"start": {"line": 3, "column": 4}}}, "severity": "WARNING"}

- **Sub-font grouping** - A single file can carry several related fonts, such as Regular, Bold, and Italic, each pointing at its own Character Tables.

Check warning on line 5 in snippets/font_table/brief.md

View workflow job for this annotation

GitHub Actions / vale

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

[write-good.Weasel] 'several' is a weasel word!
Raw output 
{"message": "[write-good.Weasel] 'several' is a weasel word!", "location": {"path": "snippets/font_table/brief.md", "range": {"start": {"line": 5, "column": 51}}}, "severity": "WARNING"}
4 changes: 1 addition & 3 deletions snippets/font_table/links/brief/character_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# character_tables

Write the documentation content for character_tables here.
Length byte followed by that many Character Table indices this font table may reference.
1 change: 1 addition & 0 deletions snippets/font_table/links/condition/character_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `link_character_tables` is enabled.

Check notice on line 1 in snippets/font_table/links/condition/character_tables.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/links/condition/character_tables.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/font_table/links/condition/character_tables.md", "range": {"start": {"line": 1, "column": 28}}}, "severity": "INFO"}

Check notice on line 1 in snippets/font_table/links/condition/character_tables.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/links/condition/character_tables.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/font_table/links/condition/character_tables.md", "range": {"start": {"line": 1, "column": 28}}}, "severity": "INFO"}

Check warning on line 1 in snippets/font_table/links/condition/character_tables.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/font_table/links/condition/character_tables.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/font_table/links/condition/character_tables.md", "range": {"start": {"line": 1, "column": 28}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/font_table/links/flag/link_character_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This table links to one or more Character Tables.
4 changes: 1 addition & 3 deletions snippets/font_table/records/brief/author.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# author

Write the documentation content for author here.
Author, manufacturer, or credits for the font.
4 changes: 1 addition & 3 deletions snippets/font_table/records/brief/character_table_indexes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# character_table_indexes

Write the documentation content for character_table_indexes here.
Length byte followed by that many Character Table indices this font may access and use.
4 changes: 1 addition & 3 deletions snippets/font_table/records/brief/font_type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# font_type

Write the documentation content for font_type here.
Style of this font (0 = Regular, 1 = Bold, 2 = Italic).

Check notice on line 1 in snippets/font_table/records/brief/font_type.md

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "snippets/font_table/records/brief/font_type.md", "range": {"start": {"line": 1, "column": 20}}}, "severity": "INFO"}
4 changes: 1 addition & 3 deletions snippets/font_table/records/brief/name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# name

Write the documentation content for name here.
Human-readable font name.
4 changes: 1 addition & 3 deletions snippets/font_table/records/brief/version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# version

Write the documentation content for version here.
Revision number of this font,

@coderabbitai coderabbitai Bot Jul 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Remove the trailing comma.

Line 1 should end with a period so the generated description is grammatically complete.

🤖 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/brief/version.md` at line 1, Update the
description in version.md so the line ends with a period instead of a trailing
comma.

Source: Linters/SAST tools

1 change: 1 addition & 0 deletions snippets/font_table/records/condition/author.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present.
1 change: 1 addition & 0 deletions snippets/font_table/records/condition/character_table_indexes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present.
1 change: 1 addition & 0 deletions snippets/font_table/records/condition/font_type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present.
1 change: 1 addition & 0 deletions snippets/font_table/records/condition/name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present.
1 change: 1 addition & 0 deletions snippets/font_table/records/condition/version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present.
6 changes: 4 additions & 2 deletions snippets/pixmap_table/brief.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# pixmap_table table
Stores glyph data as collections of pixels within pixmaps, representing the visual appearance of a character.

@coderabbitai coderabbitai Bot Jul 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add Pixmap terminology to the Vale vocabulary. These valid specification terms currently fail documentation CI.

  • snippets/pixmap_table/brief.md#L1-L1,L5-L5: register pixmap and pixmaps.
  • snippets/pixmap_table/configurations/brief/constant_bits_per_pixel.md#L1-L1: register pixmaps.
  • snippets/pixmap_table/configurations/brief/constant_height.md#L1-L1: register pixmaps.
  • snippets/pixmap_table/configurations/brief/constant_width.md#L1-L1: register pixmaps.
  • src/Pixmap Table.md#L63-L63,L168-L168,L172-L172,L181-L187,L193-L193: register pixmap, pixmaps, and Pixmap.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

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

🪛 GitHub Actions: vale / vale

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

🪛 GitHub Check: vale

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

📍 Affects 5 files
  • snippets/pixmap_table/brief.md#L1-L1 (this comment)
  • snippets/pixmap_table/brief.md#L5-L5
  • snippets/pixmap_table/configurations/brief/constant_bits_per_pixel.md#L1-L1
  • snippets/pixmap_table/configurations/brief/constant_height.md#L1-L1
  • snippets/pixmap_table/configurations/brief/constant_width.md#L1-L1
  • src/Pixmap Table.md#L63-L63
  • src/Pixmap Table.md#L168-L168
  • src/Pixmap Table.md#L172-L172
  • src/Pixmap Table.md#L181-L187
  • src/Pixmap Table.md#L193-L193
🤖 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/pixmap_table/brief.md` at line 1, Register the valid Pixmap
terminology in the Vale vocabulary: add pixmap and pixmaps for
snippets/pixmap_table/brief.md lines 1-1 and 5-5, pixmaps for each configuration
brief at the specified lines, and pixmap, pixmaps, and Pixmap for the listed
occurrences in src/Pixmap Table.md lines 63, 168, 172, 181-187, and 193.

Source: Pipeline failures


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

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

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_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/pixmap_table/brief.md", "range": {"start": {"line": 3, "column": 4}}}, "severity": "WARNING"}

- **Glyph storage** - Contains the pixmap images for font characters
4 changes: 1 addition & 3 deletions snippets/pixmap_table/configurations/brief/constant_bits_per_pixel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# constant_bits_per_pixel

Write the documentation content for constant_bits_per_pixel here.
The bits per pixel shared by all pixmaps in this table (only 1-8 supported).

Check notice on line 1 in snippets/pixmap_table/configurations/brief/constant_bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "snippets/pixmap_table/configurations/brief/constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 56}}}, "severity": "INFO"}
4 changes: 1 addition & 3 deletions snippets/pixmap_table/configurations/brief/constant_height.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# constant_height

Write the documentation content for constant_height here.
The height in pixels shared by all pixmaps in this table.
4 changes: 1 addition & 3 deletions snippets/pixmap_table/configurations/brief/constant_width.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# constant_width

Write the documentation content for constant_width here.
The width in pixels shared by all pixmaps in this table.
1 change: 1 addition & 0 deletions snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_bits_per_pixel` is enabled

Check notice 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 

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

Check notice 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.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/pixmap_table/configurations/condition/constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 34}}}, "severity": "INFO"}

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 

[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/pixmap_table/configurations/condition/constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 34}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/pixmap_table/configurations/condition/constant_height.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_height` is enabled.

Check notice 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 

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

Check notice 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.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/pixmap_table/configurations/condition/constant_height.md", "range": {"start": {"line": 1, "column": 26}}}, "severity": "INFO"}

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 

[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/pixmap_table/configurations/condition/constant_height.md", "range": {"start": {"line": 1, "column": 26}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/pixmap_table/configurations/condition/constant_width.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_width` is enabled.

Check notice 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 

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

Check notice 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.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/pixmap_table/configurations/condition/constant_width.md", "range": {"start": {"line": 1, "column": 25}}}, "severity": "INFO"}

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 

[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/pixmap_table/configurations/condition/constant_width.md", "range": {"start": {"line": 1, "column": 25}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All pixmaps in this table use the same number of bits to represent a pixel.

@coderabbitai coderabbitai Bot Jul 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add pixmaps to Vale’s accepted vocabulary.

Both documentation lines use the project’s domain term pixmaps, but Vale currently fails the pipeline on that spelling. Update the Vale vocabulary/configuration rather than rewriting both valid descriptions.

  • snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1-L1: retain the wording after configuring Vale to accept pixmaps.
  • snippets/pixmap_table/configurations/flag/use_constant_height.md#L1-L1: retain the wording after configuring Vale to accept pixmaps.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt

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

🪛 GitHub Actions: vale / vale

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

🪛 GitHub Check: vale

[failure] 1-1: [vale] snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1
[Vale.Spelling] Did you really mean 'pixmaps'?

📍 Affects 2 files
  • snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1-L1 (this comment)
  • snippets/pixmap_table/configurations/flag/use_constant_height.md#L1-L1
🤖 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/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md` at
line 1, Add pixmaps to Vale’s accepted vocabulary/configuration so the existing
domain terminology passes validation. Preserve the wording in
snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md lines
1-1 and snippets/pixmap_table/configurations/flag/use_constant_height.md lines
1-1 without edits.

Sources: Linters/SAST tools, Pipeline failures

1 change: 1 addition & 0 deletions snippets/pixmap_table/configurations/flag/use_constant_height.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All pixmaps in this table share the same height.
1 change: 1 addition & 0 deletions snippets/pixmap_table/configurations/flag/use_constant_width.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All pixmaps in this table share the same width.
4 changes: 1 addition & 3 deletions snippets/pixmap_table/links/brief/color_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# color_tables

Write the documentation content for color_tables here.
Length byte followed by that many Color Table indices supplying the palette that pixel values index into.
1 change: 1 addition & 0 deletions snippets/pixmap_table/links/condition/color_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `link_color_tables` is enabled.

Check notice on line 1 in snippets/pixmap_table/links/condition/color_tables.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/links/condition/color_tables.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/pixmap_table/links/condition/color_tables.md", "range": {"start": {"line": 1, "column": 24}}}, "severity": "INFO"}

Check notice on line 1 in snippets/pixmap_table/links/condition/color_tables.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/links/condition/color_tables.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/pixmap_table/links/condition/color_tables.md", "range": {"start": {"line": 1, "column": 24}}}, "severity": "INFO"}

Check warning on line 1 in snippets/pixmap_table/links/condition/color_tables.md

View workflow job for this annotation

GitHub Actions / vale

[vale] snippets/pixmap_table/links/condition/color_tables.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/pixmap_table/links/condition/color_tables.md", "range": {"start": {"line": 1, "column": 24}}}, "severity": "WARNING"}
1 change: 1 addition & 0 deletions snippets/pixmap_table/links/flag/link_color_tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This table links to one or more Color Tables for palette mapping
4 changes: 1 addition & 3 deletions snippets/pixmap_table/records/brief/bits_per_pixel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# bits_per_pixel

Write the documentation content for bits_per_pixel here.
Bits used to represent each pixel of this pixmap (only 1-8 supported).

Check notice on line 1 in snippets/pixmap_table/records/brief/bits_per_pixel.md

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "snippets/pixmap_table/records/brief/bits_per_pixel.md", "range": {"start": {"line": 1, "column": 50}}}, "severity": "INFO"}
Loading
Loading