DocDiff: color highlights should override text color

[thibaudcolas]

I’m trying to provide feedback for the new DocDiff feature as part of the new Addons, please let me know if there’s a better venue for that.

Details

• Read the Docs project URL: https://readthedocs.org/projects/wagtail/
• Read the Docs username (if applicable): https://readthedocs.org/profiles/thibaudcolas/

Expected Result

I’d expect DocDiff highlights to be readable regardless of what theme I use with Read the Docs. Demo where I tried this on: Wagtail API v2 Configuration Guide - Authentication - PR #12363

Actual Result

With a dark theme we get:

---

Additionally the d shortcut was pretty hard to find (had to look through the various announcements to figure out what I might be missing, and then figure out where DocDiff is documented). I was expecting a toggle within the flyover menu.

[humitos]

I’m trying to provide feedback for the new DocDiff feature as part of the new Addons, please let me know if there’s a better venue for that.

Thanks for your feedback. I transferred the issue to the addons repository.

I’d expect DocDiff highlights to be readable regardless of what theme I use with Read the Docs

I don't think we can auto-detect the colorscheme of the documentation and adapt its colors based on that. However, we could provide a way to manually configure these colors. We are using CSS variables for similar configurations for other addons. Would that work in your case?

Additionally the d shortcut was pretty hard to find (had to look through the various announcements to figure out what I might be missing, and then figure out where DocDiff is documented). I was expecting a toggle within the flyover menu.

Yes. We are already aware of this and we are working to integrate these new features in the flyout so they are easier to discover.

[thibaudcolas]

Thank you @humitos! I wasn’t expecting the implementation to auto-detect the color scheme, just override the text color in addition to the background. Though if you wanted to do some auto-detection this would be partly possible with the color-scheme meta.

CSS variables sound great too, but I’d also be very happy to just see the text color overridden to black so at least the text is readable without requiring theme customizations.