Do a basic accessibility pass over the docs
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
Issue:
I don't have any disability, came to the docs (https://rethinkdb.com/docs/install/windows/) and was finding it slightly hard to read. Ran a quick checker tool (WAVE plugin for Chrome), and as I suspected, loads of very low contrast text. This is impeding readability for someone with 20/20 vision, so I assume makes it impossible for people with any visual impairment.
Suggestion:
Consider doing a basic accessibility check. There are tools like the WAVE plugin which allow very quick checks of a few basics, or https://accessibilityinsights.io/ which offers more detailed reports. I ran its fast-pass assessment, and it looks like a few simple fixes (contrast, add a lang attribute to the html tag, and ensure images have alt text) would make a big difference.
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 with the Windows installation page at https://rethinkdb.com/docs/install/windows/ and run the WAVE plugin or Accessibility Insights fast-pass assessment. Review the reported contrast, HTML lang attribute, and image alt-text issues across the documentation, with the accessibility findings resolved as the completion check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, html
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100