[docs] Add Accessibility section to all component demo pages
A pull request for this has already been merged.
- #20965 by @eps1lon — merged
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
- I have searched the issues of this repository and believe that this is not a duplicate.
Summary 💡
Many components' documentation contains an Accessibility section that tells you how to make sure your components are Accessible, but some components don't contain this section.
For the sections that don't contain Accessibility, it isn't clear if that means that the component is accessible without any special measures, or if it isn't accessible at all.
It would be helpful if each component had an Accessibility section that says which is the case:
- Component is accessible without extra work.
- Component requires special measures to make accessible.
- Component is not accessible.
Examples 🌈
See
https://material-ui.com/components/tables/#accessibility
vs
https://material-ui.com/components/popper/
Motivation 🔦
I want to make sure I only use accessible components in my development.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the existing Accessibility section on the Tables component page with the Popper component page, then review the other component demo pages for the same missing section. Done means every component page explains whether the component is accessible without extra work, needs special measures, or is not accessible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- accessibility, documentation, frontend
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100