ADA 2024-04-24 Rule (WCAG 2.1, Level AA) compliance
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
We need to ensure our docs are in compliance with the ADA 2024-04-24 rule by 2026-04-24. This means compliance with at least WCAG 2.1, Level AA.
This should be relatively straightforward. Bear in mind one major goal is to make content perceivable to readers with low vision or blindness. Some things to ensure compliance:
- Ensure the presence and quality of alt-text. https://www.wcag.com/blog/good-alt-text-bad-alt-text-making-your-content-perceivable/
- Ensure sufficient contrast ratios in style.
- Ensure sufficient contrast ratios in text-based images.
- Ensure screen readers can perceive text from text-based images by supplying a transcription of the contents in the document body.
And we need to ensure we are checking all of the above during PRs. It would be helpful to have a PR template with a checklist of all the relevant items.
Additional resources and reading:
- Fact Sheet: https://www.ada.gov/resources/2024-03-08-web-rule/
- WCAG Guidelines: https://www.w3.org/WAI/standards-guidelines/wcag/
- Fundamentals Overview: https://www.w3.org/WAI/fundamentals/
Contributor guide
No contributing guide indexed for this repository
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 reviewing the documentation against the linked ADA and WCAG resources, focusing on alt-text, contrast, and transcriptions for text-based images. Then inspect the repository's pull request process to determine where an accessibility checklist belongs. Done means the documentation meets the stated WCAG 2.1 Level AA checks and pull requests include a checklist for them.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100