Skip to content
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

Documentation pages not colorblind friendly #164

Open
C-Compton opened this issue Aug 24, 2021 · 5 comments
Open

Documentation pages not colorblind friendly #164

C-Compton opened this issue Aug 24, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@C-Compton
Copy link

Is your feature request related to a problem? Please describe.
This is not a major issue, but it is something that is often overlooked in UX design.

I was reading through documentation on Tribuo when I noticed an issue regarding the color palette of hyperlinks and keywords. I'm colorblind (red/green), and they (links and keywords) appear to me as the same or very similar colors. Because of this, I was attempting to click on keywords for more information only to find that they were not links.

Describe alternatives you've considered

There are a couple of possible solutions. Hyperlinks could have some visual indicator such as being underlined. Fonts of keywords or links (or both) could be chosen so that they are immediately identifiable as being different. Lastly, the color palettes chosen for them could be made more distinct. An option could even be created for visitors of the page to enable a colorblind friendly palette so as not to upset the UX design of the site.

@C-Compton C-Compton added the enhancement New feature or request label Aug 24, 2021
@Craigacp Craigacp added the documentation Improvements or additions to documentation label Aug 24, 2021
@Craigacp
Copy link
Member

Craigacp commented Aug 24, 2021

Ok, that's definitely something we should fix. Do you have recommendations for syntax highlighting colour schemes which work better for people who are colourblind? I think the only presence of green in our docs is in the code snippets and in the jupyter notebook exported tutorials, however the links & class names are in very similar shades of red and I'm not sure if that is also a problem. We should be able to easily fix the code snippets & red shades in the docs. The jupyter notebook syntax highlighting might be harder as we use their standard exporter and I'm not sure what control it provides over that.

The non-colour modifications such as underlining & fonts should be fairly easy, we'll have a look at a few options.

@C-Compton
Copy link
Author

The similar shades of red were the issue I was trying to point out specifically.

There are different types of color blindness so I can't say that I can recommend a single color scheme that would work for everyone outside of using very high contrasting colors, which may effect your UX design, but also won't be a cure-all. A typical cure-all solution is to try and pick the best possible color palette and have some visual, non-color related indicator that they're different, such as different fonts or underlined links.

There are many references out there that talk about picking colorblind friendly palette.
Here are a couple I found with a quick search. There may be better references than these with a deeper search.

https://www.tableau.com/about/blog/examining-data-viz-rules-dont-use-red-green-together
https://davidmathlogic.com/colorblind/#%23D81B60-%231E88E5-%23FFC107-%23004D40

@Craigacp
Copy link
Member

Ok thanks for the information. I think currently every link underlines when you mouse-over it (and the ones in the exported tutorial notebooks are always underlined), but that's obviously not so useful at a glance. It would be better if we consistently linked the class names to the javadoc as then they would all be links all the time, but I agree the colours would still need fixing to differentiate keywords and plain links.

We'll take a look at the colour palette and find something with a bit more diversity.

@Craigacp
Copy link
Member

We're modifying the stylesheet on the website (oracle/tribuo-site#10) to make code tags bolded and links always underlined. The colour palette hasn't changed much, but if it's still tricky to differentiate things then we can move to a more diverse one. We did a few checks using tooling which simulates red/green colourblindness and the formatting changes seemed sufficient to make the different elements distinct, but let us know if it's not and we'll sort it.

@jhalexand
Copy link
Member

Due to my not paying enough attention, those changes only went live this morning, rather than on Friday. But they are live now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants