-
-
Notifications
You must be signed in to change notification settings - Fork 524
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
Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 #1105
Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 #1105
Conversation
This fix required moving the mkdocs theme out of the docs directory. It's no in the docs_theme directory, and the mkdocs config is updated accordingly.
Also, move the pa11y script into the gh actions workflow
This comment has been minimized.
This comment has been minimized.
I tried to keep the colors as similar to the original as possible, but now with the higher contrast, some of the colors look a bit garish. Like this page honestly looks a bit alarming. Maybe we should tone down the red? |
09bc99e
to
512bd53
Compare
This comment has been minimized.
This comment has been minimized.
Okay, all colors are now updated, and this PR should be good to go. |
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.
📄📄📄📄
Unit Test Results 9 files 9 suites 0s ⏱️ results for commit 558d331 |
Fixes #1061
This PR fixes all of the acessibility issues that pa11y was reporting on our docs site. It also re-enables accessibility testing for PRs and branches that change anything related to the docs.
The main issues were:
jrnl.sh will now meet the AAA standard specified in WCAG 2.1, which is to have a minimum of 4.5:1 contrast ratio for all text on the site.
No submit button makes it hard for anyone that can't use a keyboard to search our docs site. Now there's a button, so everybody wins.
Note that I had to move the mkdocs theme folder out of
docs
and intodocs_theme
. This is because readthedocs doesn't recognizemain.html
(which is necessary to add the missing search button) inside of the docs directory. Mkdocs' site says not to put the custom theme inside the docs directory anyway, so I guess this fixes both of those issues at once.Also, here's an example build where this all ran successfully:
Checklist
for the same issue.