Skip to content

Docs site: every number rendered, six components documented, one finding-ID space - #9

Merged
LinzLos merged 1 commit into
mainfrom
legible-site
Sep 20, 2026
Merged

LinzLos merged 1 commit into
mainfrom
legible-site

Conversation

@LinzLos

@LinzLos LinzLos commented Sep 20, 2026

Copy link
Copy Markdown
Owner

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 (replaces render-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, and docs.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-stat locally 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.py reports 0 undocumented class families
  • Every relative link in docs/*.html resolves
  • Every nav anchor in docs.js exists on its page; nav order equals page order
  • All five new component sections checked in a browser, light theme
  • Foundations renders 186 token rows

Not covered

  • Dark theme not visually checked on the new sections (they use tokens only, so the risk is low)
  • The a11y checker's own computed output is unchanged by this PR and wasn't re-run
  • Consumer repos' sync-tinywire.sh comments still say "Profile A / B"; those are separate repos

…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.
@LinzLos
LinzLos merged commit 44c7248 into main Sep 20, 2026
1 check passed
@LinzLos
LinzLos deleted the legible-site branch September 20, 2026 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant