New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Accessibility improvements to the left nav #638
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The improvements and code look good!
This also fixes #453
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Definitely an improvement.
The contrast between toctree captions like "Demo documents" and the links has decreased with these changes. Have you considered making the entire menu background a bit darker (versions menu bg could go to full black)? This will also increase contrast between bg and text, and you don't have to lighten the captions as much.
By itself though, going to jet black (#000) will not solve the problem. The accessibility rating would only be acceptable for large headings. The other problem is that the left navigation would blend in with the version menu at the bottom ("Read the Docs v:latest") I suspect we can slightly darken the captions ("Demo documents") though while still keeping a good rating. I'll see what I can do. |
I made a slight tweak to the colors to try to get a little more differentiation between the captions ("DEMO DOCUMENTS") and the links ("Structural elements"). I reduced it down to essentially the least contrast of the caption so that we retain a AA accessibility rating with the background. |
Excellent! Is there a milestone / timeline for getting this released? I assume I'll just have to re-pin to the new release in my requirements.txt. Thanks! |
If you've pinned to a precise version, yes, you'll need to re-pin. If you haven't, or you pinned to something like |
This makes a few color changes to the left navigation with an eye toward improved accessibility. Specifically, I looked at the colors on our existing theme and they don't have enough contrast. The headings are the worst offenders but some of the links aren't fantastic.
Ping @mahmoud