ansible / awx-plugins

https://awx-plugins-core.rtfd.io
Apache License 2.0
5 stars 12 forks source link

🎨 Add Ansible brand colors to the docs theme #35

Closed samccann closed 1 month ago

samccann commented 2 months ago

This uses the Ansible pool logo for a splash of color, and a different color for the left-hand navigation to make it stand out a bit more.

Preview: https://awx-plugins-core--35.org.readthedocs.build.

webknjaz commented 2 months ago

@samccann do you think these are all the changes that would be necessary in a new theme?

I checked the color contrast with DevTools (against the background) and it's good for the dark theme variant but not ideal for the light one. Do we have a darker logo variant that would satisfy the accessibility recommendations?

samccann commented 2 months ago

So the goal here was to make as few changes as possible for now. There could be more work if we really want to customize this as he theme has a lot of flexibility on playing with colors. I thought the Ansible pool logo had the splash of Ansible color that people could recognize.

As for the nav/toc change - I found the allwhite navigation harder to notice so tried to make that a different color that still worked with existing font colors etc.

webknjaz commented 2 months ago

@samccann I also noticed that the logo size got smaller. Is that on purpose?

webknjaz commented 2 months ago

So Firefox's accessibility tool reports contrast problems with the ToC titles in the light theme variant. It needs to be fixed before the change is acceptable UX-wise. I'd like to also compare with what Lighthouse says.

samccann commented 2 months ago

Logo size - yes that was deliberate. The existing logo imo is too large. That said, since this is awx-related, do we want to use the awx logo?

webknjaz commented 2 months ago

That's a good question. Personally I liked the original black-and-white variants. Anyway, I don't think I should be deciding which logo to use beyond checking the accessibility implications that I'm doing.

cc @chrismeyersfsu @TheRealHaoLiu @thedoubl3j @djyasin plz share your thoughts on this

samccann commented 1 month ago

Going to close this PR out for now. I won't get back to it for some time and think I was just bringing my own bias (aka what I was used to looking at) into this theme. My nickel would be the team should decide on whether the logo is AWX or Ansible as the only change to make.