-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
ff56ff5
656077e
c38768d
42fdd28
e4ba5c3
cfb2179
ce4a064
5093cd0
e9f43de
0f9204e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ on: | |
| push: | ||
| branches: | ||
| - main | ||
| - documentation | ||
|
|
||
| jobs: | ||
| sync-wiki: | ||
|
|
||
| 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
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Resolve Vale spelling failure ( CI is failing on this line. Replace 🧰 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 🤖 Prompt for AI Agents |
||
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
|
||
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
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix CI-blocking spelling in Vale fails on 🧰 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 [failure] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 [notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 [notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 [warning] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 🤖 Prompt for AI Agents |
||
| 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
|
||
|
|
||
| Write the documentation content for color_table table here. | ||
| ## Use Cases | ||
|
Check warning on line 3 in snippets/color_table/brief.md
|
||
|
|
||
| - **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
|
||
| - **Color storage** - Can store color sets independently for other purposes. | ||
|
Comment on lines
+1
to
+6
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Address Vale spelling failures for 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 [warning] 1-1: [vale] snippets/color_table/brief.md#L1 [notice] 1-1: [vale] snippets/color_table/brief.md#L1 [notice] 1-1: [vale] snippets/color_table/brief.md#L1 [failure] 1-1: [vale] snippets/color_table/brief.md#L1 [warning] 3-3: [vale] snippets/color_table/brief.md#L3 [failure] 5-5: [vale] snippets/color_table/brief.md#L5 [failure] 5-5: [vale] snippets/color_table/brief.md#L5 🤖 Prompt for AI Agents |
||
| 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
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| All colors in this table share the same alpha value. |
| 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. |
| 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
|
||
| 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
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1 @@ | ||
| # blue | ||
|
|
||
| Write the documentation content for blue here. | ||
| Blue channel value. |
| 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
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1 @@ | ||
| # green | ||
|
|
||
| Write the documentation content for green here. | ||
| Green channel value. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1 @@ | ||
| # red | ||
|
|
||
| Write the documentation content for red here. | ||
| Red channel value. |
| 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
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Always present |
| 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
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Always present |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Always present |
| 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
|
||
|
|
||
| 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
|
||||||||||||||
|
|
||||||||||||||
| Write the documentation content for character_table_indexes here. | ||||||||||||||
|
Check failure on line 3 in snippets/font_table/records/condition/character_table_indexes.md
|
||||||||||||||
|
Comment on lines
+1
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix Vale spelling failures in heading/body token usage (Line 1, Line 3).
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
Suggested change
🧰 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 [warning] 1-1: [vale] snippets/font_table/records/condition/character_table_indexes.md#L1 🤖 Prompt for AI Agents |
||||||||||||||
| 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
|
||||||||||||||
|
|
||||||||||||||
| Write the documentation content for font_type here. | ||||||||||||||
|
Check failure on line 3 in snippets/font_table/records/condition/font_type.md
|
||||||||||||||
|
Comment on lines
+1
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Resolve CI-breaking spelling errors for 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
Suggested change
🧰 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 [warning] 1-1: [vale] snippets/font_table/records/condition/font_type.md#L1 [failure] 3-3: [vale] snippets/font_table/records/condition/font_type.md#L3 🤖 Prompt for AI Agents |
||||||||||||||
| 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
|
||
|
|
||
| Write the documentation content for name here. | ||
| 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
|
||
|
|
||
| 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
|
||
| 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
|
||
| 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
|
||
| 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
|
||
| 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
|
||
| 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
|
||
| 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
|
||
| 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
|
||
| 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
|
||
| 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
|
||
|
|
||
| Write the documentation content for bits_per_pixel here. | ||
|
Check failure on line 3 in snippets/pixmap_table/records/condition/bits_per_pixel.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
|
||
|
|
||
| Write the documentation content for data here. | ||
| 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
|
||
|
|
||
| Write the documentation content for height here. | ||
| 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
|
||
|
|
||
| Write the documentation content for width here. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: SimplePixelFont/Specification
Length of output: 1589
Pin third-party CI code and avoid remote
npxgit execution inwiki.yml(triggered bydocumentationpushes).Adding
documentationto theon: pushbranches runs a workflow that depends on mutable/upstream-changing code paths:actions/checkout@v2,newrelic/wiki-sync-action@main, andnpx https://github.com/The-Nice-One/rail-yard.git .... Pin actions/tools to immutable commit SHAs and replace the remotenpxgit URL with a pinned/vetted dependency (or vendored code) so upstream changes can’t affect CI without review.🤖 Prompt for AI Agents