Repository navigation
Docs site: every number rendered, six components documented, one finding-ID space - #9
Merged
Merged
Conversation
…ing-ID space scripts/render-docs.py replaces render-readme.py and writes the token, component, pattern, and finding counts and the version into the README, the intro page, the components page, the audit card, and docs.js. Foundations gains an Every-token table rendered from tokens.css (186; the curated sections show 92). Divider, Kbd, Spinner, Status Bar, and Status Dot get sections — six shipped class families had no page. The audit's v1.3/v1.5 findings are renumbered F-018–F-023; F-013–F-017 stay with the a11y page and the changelog. Intro page no longer says brand is forest green. 'What I won't ship' is dated Decisions; 'What's next' points at the hub docket. Tiny Wire.html (orphan single-file copy) removed. Sidebar rail in the nav.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs-site half of the legibility pass. Same rule as the markdown pass: every claim either names what checks it, or names whose call it was and when.
What changed
Numbers are rendered, not typed.
scripts/render-docs.py(replacesrender-readme.py) counts tokens, documented components, patterns, and findings from the source, and writes them into the README, the intro page, the components page, the audit card, anddocs.js. Hand edits between the markers are overwritten.Foundations gets an Every-token table — all 186, light and dark, grouped by tier, rendered from
lib/tokens.css. The curated sections above it show 92, which was the whole reference until now.Six shipped components had no docs section. Divider, Kbd, Spinner, Status Bar, and Status Dot now have one; documented count goes 30 → 35, undocumented goes to 0. This was a real cost, not tidiness — one consumer rebuilt
.status-statlocally because it couldn't find it.One finding-ID space. The audit page's v1.3/v1.5 findings reused F-013–F-018, which the a11y page and the changelog already used for the v1.1 contrast findings. The audit's are renumbered F-018–F-023; the a11y page keeps the originals, so the changelog's references now resolve to one place.
Judgment is labeled as judgment. "What I won't ship" is now Decisions, each dated to the release it was made at; the icon decision is amended for Phosphor. "What's next" no longer carries its own roadmap — it points at the hub's candidates table, where every row is something a real app built.
Fixed: the intro page said brand is forest green (cobalt since v1.5) and carried four stale counts.
Tiny Wire.html— a 1,579-line single-file copy at the repo root with its own token values, linked from nowhere — is deleted; git history keeps it. The sidebar-rail example is in the nav.Verified
render-docs.pyreports 0 undocumented class familiesdocs/*.htmlresolvesdocs.jsexists on its page; nav order equals page orderNot covered
sync-tinywire.shcomments still say "Profile A / B"; those are separate repos