UCL-ARC / UCL-ARC/mkdocs-rc-docs
Nav link contrast with background/other text too low
Nobody has claimed this yet.
- Dominant language
- Rich Text Format
- Stars
- 41
- Forks
- 22
- Avg merge
- 1m
- Merged PRs (30d)
- 14
Description
While looking at the code snippet colours, @dstansby posted this link to an accessibility analysis tool which suggested that the contrast on the navigation links may be too low.
Worth taking a look in both dark and light mode to see if we should override these, probably using the SCSS variables, e.g. in https://github.com/UCL-RITS/mkdocs-rc-docs/blob/master/mkdocs-project-dir/docs/stylesheets/tweaks.css.
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
Review the navigation styling in docs/stylesheets/tweaks.css and the linked WAVE accessibility analysis. Compare navigation-link contrast against backgrounds and other text in both dark and light modes, then verify that the adjusted colors meet the intended contrast requirement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scss
- Domain
- accessibility, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100