search

jothepro / doxygen-awesome-css

Custom CSS theme for doxygen html-documentation with lots of customization parameters.
https://jothepro.github.io/doxygen-awesome-css/
MIT License
956 stars 108 forks source link

Note and warning text block colors are semantically misleading #123

Closed dsieger closed 7 months ago

dsieger commented 12 months ago

Ok now this is about details, but: I think the colors for the "Note" and "Warning" text boxes produced by the \note and \warning commands are semantically misleading.

Notes use orange, but in most other systems this defaults to some more neutral color like blue (like your "Todo" boxes). After all, a note is just that: something noteworthy. I want the reader to take note, but I don't want to alert him. No danger, no harm.

Similar, the "Warning" boxes probably should use orange to signify potential danger, whereas red should be reserved for something definitely bad, like bugs.

Just my 2 cents, feel free to close immediately.

jothepro commented 12 months ago

Tbh not a lot of thought has been going into the current coloring, so your 2 cents are welcome! 😋 Keeping this open a reminder that the colors could be improved.

ilg-ul commented 12 months ago

I also find the choice of colours unusual, even misleading. The other sites that I manage use a colour convention similar to the one suggested by @dsieger.

jothepro commented 7 months ago

I've applied the color scheme from https://github.com/pmp-library/pmp-library/commit/54e8e755096edb59fe22f782b622c74b2269acff and I like it a lot more than the previous coloring! It's now available in v2.3.0. Thanks for the feedback!