executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
432 stars 197 forks source link

Source buttons are not very discoverable #847

Open leifwalsh opened 3 months ago

leifwalsh commented 3 months ago

Context

image

I find (and have confirmed with users of my documentation) that the Source Buttons---for finding the source code, reporting an issue, or editing the current page---are not very discoverable or intuitive. The only initial indication is the github logo, and depending on the kind of thing you're documenting, its users may not know what github is, recognize the logo, have the concept of there being "source code" for the website they're reading, or make the connection from that logo to "this is how I provide feedback about this website". It's also not clear something will happen on hover.

Proposal

It would be nice to have the option to make these buttons all appear on the page without hovering, and with their explanatory text. I think there's enough horizontal space in the default layout for this, something like:

[šŸ± Source] [āœšŸ» Edit page] [šŸ’” Feedback]

This could be an option (whether to keep these buttons under the hover menu, or pull them up to page level).

I'd be willing/interested to contribute such a change, but I'd like to discuss the idea first, and would probably appreciate a pointer about where in the codebase to start.

Tasks and updates

No response