Skip to content

Docs: Add accessibility documentation structure and guidance pages - #286

Open
zoharma wants to merge 5 commits into
mainfrom
zma/docs-a11y-guidelines
Open

zoharma wants to merge 5 commits into
mainfrom
zma/docs-a11y-guidelines

Conversation

@zoharma

@zoharma zoharma commented Sep 2, 2026

Copy link
Copy Markdown
Contributor
  • Overview: core a11y principles (clarity, predictability, keyboard access), do/don't guidance for interactive elements, forms, and icons, plus a quick sense-check list
  • Colour contrast and vision: why APCA drives colour decisions with WCAG 2.2 as the compliance floor, worked examples (the Warning button, an open danger-text obvious/readable/compliant trade-off), a colour vision deficiency section with real CVD-simulated swatches across the main, solid, and container token roles in both light and dark mode, and practical guidance/pitfalls
  • Cognitive accessibility and usability: guidance on focus, error recovery, and information processing beyond vision/hearing/motor access

@zoharma zoharma added the documentation Improvements or additions to documentation label Sep 2, 2026
@zoharma zoharma added this to the 0.8.0 milestone Sep 10, 2026
@zoharma zoharma modified the milestones: 0.10.0, 0.9.0 Oct 6, 2026
@zoharma zoharma added the priority/p2-medium Planned, should do label Oct 27, 2026
@zoharma
zoharma force-pushed the zma/docs-a11y-guidelines branch from 8febcce to 45c7349 Compare November 9, 2026 10:48
@zoharma
zoharma marked this pull request as ready for review November 10, 2026 15:52
@zoharma
zoharma requested review from a team and VictoriaBeilsten-Edmands November 10, 2026 15:52
@zoharma
zoharma removed the request for review from VictoriaBeilsten-Edmands November 10, 2026 15:52
- Overview: core a11y principles (clarity, predictability, keyboard access), do/don't guidance for interactive elements, forms, and icons, plus a quick sense-check list
- Colour contrast and vision: why APCA drives colour decisions with WCAG 2.2 as the compliance floor, worked examples (the Warning button, an open danger-text obvious/readable/compliant trade-off), a colour vision deficiency section with real CVD-simulated swatches across the main, solid, and container token roles in both light and dark mode, and practical guidance/pitfalls
- Cognitive accessibility and usability: guidance on focus, error recovery, and information processing beyond vision/hearing/motor access
@zoharma
zoharma force-pushed the zma/docs-a11y-guidelines branch from 45c7349 to 3b6a618 Compare November 13, 2026 12:24
- Use @storybook/addon-docs/blocks (@storybook/blocks is not in Storybook 10)
- Remove intro sentence and add (a11y) to the title
- Add WCAG 2.2 and APCA links
- Fix broken Tooltip line wrap
- Shorten colour contrast page to key points and links
- Shorten cognitive accessibility page
- Condense standards section on overview
- Full versions remain in git history for the design system site
@zoharma

zoharma commented Nov 13, 2026

Copy link
Copy Markdown
Contributor Author

Fixed the issues and a few other bits. I will pull the fuller content into design-system website

- Scope focus containment to modal dialogs
- Note WCAG exemption for disabled controls
- Link overview to the colour contrast page
@zoharma
zoharma force-pushed the zma/docs-a11y-guidelines branch from 8b78b74 to 08819eb Compare November 13, 2026 12:52

@VictoriaBeilsten-Edmands VictoriaBeilsten-Edmands left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A helpful addition. 😄

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority/p2-medium Planned, should do

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants