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
1 change: 1 addition & 0 deletions .github/workflows/wiki.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- documentation

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Read-only verification: find mutable workflow dependencies and remote npx usage.
# Expected: no '`@main`' refs, no floating major tags for third-party actions, no direct npx git URLs.

echo "== Workflows with mutable action refs =="
rg -n --type=yaml 'uses:\s*[^@\s]+@(main|master|v[0-9]+)$' .github/workflows

echo
echo "== Workflows invoking remote git URLs via npx =="
rg -n --type=yaml 'run:\s*npx\s+https?://|run:\s*npx\s+github:' .github/workflows

echo
echo "== All action refs for manual audit =="
rg -n --type=yaml 'uses:\s*' .github/workflows

Repository: SimplePixelFont/Specification

Length of output: 1589


Pin third-party CI code and avoid remote npx git execution in wiki.yml (triggered by documentation pushes).

Adding documentation to the on: push branches runs a workflow that depends on mutable/upstream-changing code paths: actions/checkout@v2, newrelic/wiki-sync-action@main, and npx https://github.com/The-Nice-One/rail-yard.git .... Pin actions/tools to immutable commit SHAs and replace the remote npx git URL with a pinned/vetted dependency (or vendored code) so upstream changes can’t affect CI without review.

🤖 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 @.github/workflows/wiki.yml at line 7, The workflow triggered by pushes to
the documentation branch uses mutable third-party references; update
.github/workflows/wiki.yml to pin actions/checkout@v2 and
newrelic/wiki-sync-action@main to specific commit SHAs (replace `@v2` and `@main`
with the corresponding full commit SHA refs) and remove the remote npx git
invocation (npx https://github.com/The-Nice-One/rail-yard.git ...) by replacing
it with a pinned package version or vendored script in the repo; ensure the
updated entries reference immutable SHAs and the npx call is replaced with a
vetted dependency or local script so CI no longer executes code from an upstream
mutable URL.


jobs:
sync-wiki:
Expand Down
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
18 changes: 12 additions & 6 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}`);
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
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 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"}

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

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.

4 changes: 1 addition & 3 deletions snippets/color_table/configurations/brief/constant_alpha.md
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.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_alpha` is enabled.

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

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"}
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
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
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"}
4 changes: 1 addition & 3 deletions snippets/color_table/records/brief/alpha.md
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
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
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
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
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
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
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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_color_type` modifier is enabled.

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

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"}
1 change: 1 addition & 0 deletions snippets/color_table/records/condition/green.md
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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always present
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
@@ -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 failure 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

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

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

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

View workflow job for this annotation

GitHub Actions / vale

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

[Vale.Spelling] Did you really mean 'pixmaps'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixmaps'?", "location": {"path": "snippets/pixmap_table/configurations/brief/constant_height.md", "range": {"start": {"line": 1, "column": 36}}}, "severity": "ERROR"}
4 changes: 1 addition & 3 deletions snippets/pixmap_table/configurations/brief/constant_width.md
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.

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

View workflow job for this annotation

GitHub Actions / vale

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

[Vale.Spelling] Did you really mean 'pixmaps'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixmaps'?", "location": {"path": "snippets/pixmap_table/configurations/brief/constant_width.md", "range": {"start": {"line": 1, "column": 35}}}, "severity": "ERROR"}
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

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

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"}
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"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If `use_constant_width` is enabled.

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

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

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 'pixmaps'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixmaps'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md", "range": {"start": {"line": 1, "column": 5}}}, "severity": "ERROR"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All pixmaps in this table share the same height.

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 'pixmaps'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixmaps'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_height.md", "range": {"start": {"line": 1, "column": 5}}}, "severity": "ERROR"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All pixmaps in this table share the same 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 'pixmaps'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pixmaps'?", "location": {"path": "snippets/pixmap_table/configurations/flag/use_constant_width.md", "range": {"start": {"line": 1, "column": 5}}}, "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.
26 changes: 14 additions & 12 deletions src/Character Table.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
\textinput{../snippets/character_table/breif.md}
\textinput{../snippets/character_table/brief.md}

Specification/snippets/character_table/links/condition/link_pixmap_tables.md

## Table Structure

Expand All @@ -24,20 +26,20 @@

| 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

| Bit | Name | Description |
| --- | -------------------- | --------------------------------------------- |
| 0 | `link_pixmap_tables` | \textinput{../snippets/character_table/links/condition/link_pixmap_tables.md} |
| 0 | `link_pixmap_tables` | \textinput{../snippets/character_table/links/flag/link_pixmap_tables.md} |
| 1-7 | — | \textinput{../snippets/phrase/reserved.md} |

#### Link Arrays
Expand All @@ -54,16 +56,16 @@ 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/code_points.md} |

### Record Layout Examples

**Example 1: Minimal record** (no modifiers)
```
Character 'A' with default pixmap index 0 and default advance

Byte layout: [codepoints] [null]
Byte layout: [code_points] [null]
Binary: 01000001 00000000
Hex: 41 00
Represents: 'A' (U+0041)
Expand All @@ -73,7 +75,7 @@ Represents: 'A' (U+0041)
```
Character 'W' with custom 12-pixel advance

Byte layout: [advance_x] [codepoints] [null]
Byte layout: [advance_x] [code_points] [null]
Binary: 00001100 01010111 00000000
Hex: 0C 57 00
Represents: advance=12, 'W' (U+0057)
Expand All @@ -83,7 +85,7 @@ Represents: advance=12, 'W' (U+0057)
```
Character 'é' using pixmap at index 5

Byte layout: [pixmap_index] [codepoints] [null]
Byte layout: [pixmap_index] [code_points] [null]
Binary: 00000101 11000011 10101001 00000000
Hex: 05 C3 A9 00
Represents: pixmap_index=5, 'é' (U+00E9, UTF-8: 0xC3 0xA9)
Expand All @@ -93,15 +95,15 @@ Represents: pixmap_index=5, 'é' (U+00E9, UTF-8: 0xC3 0xA9)
```
Character '👍' with advance=16, pixmap_index=42, pixmap_table_index=1

Byte layout: [advance_x] [pixmap_index] [table_index] [codepoints (4 bytes)] [null]
Byte layout: [advance_x] [pixmap_index] [table_index] [code_points (4 bytes)] [null]
Binary: 00010000 00101010 00000001 11110000 10011111 10010001 10001101 00000000
Hex: 10 2A 01 F0 9F 91 8D 00
Represents: advance=16, pixmap=42, table=1, '👍' (U+1F44D, UTF-8: 0xF0 0x9F 0x91 0x8D)
```

**Example 5: With constant cluster codepoints**
```
Configuration: constant_cluster_codepoints = 1 (all ASCII)
Configuration: constant_cluster_code_points = 1 (all ASCII)
Character 'B' with fixed 1-byte length

Byte layout: [grapheme_cluster]
Expand All @@ -118,7 +120,7 @@ The following byte sequence defines a minimal Character Table with two character
| ------- | ---------- | ---- | -------------------------------------------------------------- |
| 1 | `00000001` | `01` | Table identifier for Character Table |
| 2 | `00000011` | `03` | Modifier flags: `use_advance_x` and `use_pixmap_index` enabled |
| 3 | `00000001` | `01` | Configuration flags: `constant_codepoint_count` enabled |
| 3 | `00000001` | `01` | Configuration flags: `constant_code_point_count` enabled |
| 4 | `00000001` | `01` | Configuration value: cluster length = 1 byte |
| 5 | `00000001` | `01` | Table links: `pixmap_tables` enabled |
| 6 | `00000001` | `01` | Pixmap table array length = 1 |
Expand Down
Loading
Loading