openrefine.org icon indicating copy to clipboard operation
openrefine.org copied to clipboard

Docs: Low contrast text in documentation

Open Abbe98 opened this issue 3 years ago • 5 comments

I'm not sure when it changed but the text contrast over at openrefine.org/docs has gotten worse, making it much harder to read and follow than in the past.

Issues includes:

  • The light blue on white text
  • Grey on white in for example the sidebars
  • Grey on grey in for example the footer

Abbe98 avatar Nov 24 '22 10:11 Abbe98

There might be a style discrepancy between docs.openrefine.org (the old version) and openrefine.org/docs (the new version). I am in the process of setting up redirects from the old to the new but any style change there is unintended.

Do you have the same contrast issues over at docs.openrefine.org? If so that is likely due to a docusaurus upgrade. If docs.openrefine.org is fine but openrefine.org/docs is not, then I messed something up in the migration (and it would be helpful to have a precise pointer to a location where they differ).

wetneb avatar Nov 24 '22 10:11 wetneb

I have set up the redirect from https://docs.openrefine.org/ to https://openrefine.org/docs/ but you can still inspect the content of the docs before the migration here: https://openrefine-docs-old.netlify.app/

wetneb avatar Nov 24 '22 12:11 wetneb

Could it be that Docusaurus do no longer support prefears-color-scheme? Switching to dark mode manually fixes most of the issues(only the footer remains inaccessible).

Abbe98 avatar Nov 24 '22 13:11 Abbe98

Docusaurus can support prefers-color-scheme but it needs enabling in the config (see https://docusaurus.io/docs/api/themes/configuration)

I don't think this has ever been enabled in our install. Of course it's possible that the default docusaurus behaviour has changed in respect to this setting but I didn't find anything indicating that had happened on a quick look

ostephens avatar Nov 24 '22 14:11 ostephens

I think the color scheme can totally be improved, I find the contrast of the white text over light blue background really not ideal on the download page in particular.

wetneb avatar Nov 24 '22 14:11 wetneb