-
Notifications
You must be signed in to change notification settings - Fork 5
Improving the traffic light system for colour blindness #526
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
Comments
I pinged UCL's Digital Accessibility team. They are going to take a general look at our pages, but in the meantime, they had some specific, signposted suggestions for this.
In particular the second link has a few nice images. Here's a good illustration of the problem: Here's a nice option: So a couple of options spring to mind...
Though technically the most fiddly (we'd have to do some CSS 😱 ) I wonder if option 4 is the best because we can use a word in plaintext
And for us "amber" is actually an OK tool:
So it's more of a "Best", "Good", "Avoid" kinda situation. |
This comment has been minimized.
This comment has been minimized.
Why is that the best? I would prefer emojis and would work better in dark mode |
Well, "Best" == most accessible, because that's what the accessibility team said...
But I think the point is: there's a plaintext thing that will appear if all emoji fails to render or can't be handled. (Like in screen readers for sight-impaired people) |
@all-contributors please add @K-Meech for bug, a11y, review |
I've put up a pull request to add @K-Meech! 🎉 |
…c's labels. (#531) An attempt to solve - #526 by replacing the emoji (same shape different colours) with a [JustTheDocs label](https://just-the-docs.com/docs/ui-components/labels/) UI component. Unfortunately, the JTD-flavoured markdown syntax for this is ```md Good {: .label .label-green} ``` ... that is to say: it needs two lines. And obviously, this doesn't work inside markdown tables. But once upon a time, I learned some HTML 🙃 so we can also access them as ```html <span class="foo"></span> ``` tags. ---- Now! This makes the markdown not look as beautiful/colourful/emojiful when viewed in GitHub...  (though arguably more readable... which is perhaps the accessibility point.) ---- Here's what it looks like on the built pages:   --------- Co-authored-by: Patrick J. Roddy <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Which Section of the Documentation Needs Improving?
The sections involving red/orange/green traffic lights such as the home page / pages for linting, packaging etc..
What Can be Improved About This Section
The traffic light system provides an easy to understand ranking of the different options, but presents some issues for people with colour blindness. The most common type of colour blindness (red / green) would make it difficult for people to distinguish the red/green traffic lights on colour alone, and other colour blindness types could make it difficult to distinguish all of them.
How to Improve This Section
In the tables of ranking (for example the linting one) - would it be possible to provide another way to distinguish the categories? For example, text indicating the different groups, or potentially having the traffic lights as different shapes (like a green tick, red cross...).
The text was updated successfully, but these errors were encountered: