Repository navigation
feat(docs): publish each component's accessibility checklist, mapped to WCAG 2.2 - #97
Merged
Merged
Conversation
…to WCAG 2.2 Each component gets a page at /docs/accessibility/<component>-checklist with every rule whose Basis names WCAG, WAI-ARIA or the APG, the WCAG 2.2 criteria behind it and a link back to its table. server/lib/checklists.ts builds the pages from the Checklist tables, and checklists.test.ts fails when they drift. Co-authored-by: multica-agent <github@multica.ai>
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://accessibility-checklists-uxf-802.opencomponents.dev, https://accessibility-checklists-uxf-802-opencomponents.blue-water-0397.workers.dev (commit 347927a)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
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.
What changed
Each of the 17 components now has an accessibility checklist of its own, like
/docs/accessibility/button-checklist, titled "Accessible Button Checklist (WCAG)". People search for checklists like "accessible combobox checklist", and until now the rules they want sat inside each component's four layer pages. Rules don't change, and neither does any layer (UX, DX or AX) of a component page.A checklist holds every rule whose Basis names WCAG, WAI-ARIA or the APG, on all four layers, which is 268 of the 639 rules. Each row shows the rule, its level, its requirement, the WCAG 2.2 success criteria its Basis cites, with their short names, levels and Understanding links, and the Basis as written. Each rule links back to its table on its layer's page, since rows have no anchors of their own. Rules whose Basis is only
HTMLorOpen Componentsstay on the component pages, since the Basis can't tell the accessibility ones among them from the rest.The pages are generated, so they can't drift from the tables:
server/lib/checklists.tsbuilds each page from its component's Checklist tables.server/lib/wcag.tsholds the WCAG 2.2 criteria, with only each one's number, short name, level and Understanding slug. A Basis that cites a criterion WCAG 2.2 doesn't have, gives the wrong level or leaves the level out failspnpm test, naming the file.server/lib/checklists.test.tscompares each page incontent/docs/4.accessibility/with what the generator builds (toMatchFileSnapshot), and fails on a changed row, a missing page or a stray file. WithCIset, it never writes a page, so CI fails on any difference.pnpm test server/lib/checklists.test.ts -uwrites them again after a rule changes./raw/copy, that the pages add no rules to the MCP server, and that the rows are exactly the rules the contracts say have such a Basis.Each page has one
title, at most 42 characters, and noseo.title, since aseo.titlewould head the/raw/copy but not the MCP server's, andpnpm check-mcpcompares them. "WCAG 2.2" is in each description and intro.The folder has no
index.md, which would make the pages parts of a split page. The sitemap,llms.txt,/raw/and the MCP server pick the pages up with no other change.AGENTS.md,.github/CONTRIBUTING.md("The docs") and a changelog entry describe them.Checklist
feat(docs): add the focus guideline.pnpm check-typespasses. (So dopnpm check-reference,pnpm test,pnpm build,pnpm check-seo,pnpm build:mcpandpnpm check-mcp.)pnpm dev. (Checked on the built site, in screenshots of the Combobox's checklist at 390px and 1440px.)pnpm build, thenpnpm lighthouse, still scores 100 in every category. (No homepage changes.)