-
Notifications
You must be signed in to change notification settings - Fork 2k
Description
The dark theme for the pico-sdk documentation is much appreciated, but it has some rough-edges.
In the pico-sdk, the web page uses a dark-red-text on black background that is very hard on the eyes. This isn't a major issue, but is something that would be very helpful to address and correct -- especially for older eyes.
I'm not a web designer, but have done a lot of dark-theme UI design. The choice of complementary colors that provide proper contrast for readability is crucial. There are a couple of axioms that the current colors used by the pico-sdk violate:
- never use dark text on dark backgrounds, (dark refers to the color-character, where, e.g. red is a "dark" color, while yellow is a "light" color);
- never use pure black for text or backgrounds (e.g.
#000000
).
The current pico-sdk violates both. Here is a screenshot from the multicore - fifo documentation:

You can alter the red (or any "dark" color) by reducing the saturation to improve contrast (e.g. #FF6464
), but with red that usually ends up looking a bit pinkish or orange, but is still much easier on the eyes than a dark red on black. Cyans work exceptionally well on a "close to black" background (something around #53C6FF
) as do faux ambers (like #FFEAB0
).
As far as replacing the pure black background with something close to pure black, a black desaturated cyan works really well to eliminate eye-strain. Anything in the range of #070A10
to #18191D
works really well. You can even get by with a bit lighter and you can tweak the desaturated offset color to suit your taste. Text renders cleaner on something that isn't pure black and your eyes with thank you. (this github page uses #0D1117
which works fine)
Again, not a major issue, but something very easily corrected by changing a couple of color-codes. Then people would have no excuse for not RTFM...
If this isn't the proper place for this issue, just let me know and I'm happy to migrate it to wherever is proper. I looked at the raspberrypi/documentation repo, but that didn't seem like the right place for pico-sdk doc issues.