DOC/website: Adjust order of subsections under 'Getting Help' in sidebar - #4799
Conversation
pygmt/doc/_templates/layout.html Line 60 in 2f3dda9 |
I feel that the footer should mainly contain information about the documentation itself, rather than project-related information. As I mentioned in #4762 (comment), the sidebar links are intended as quick access points for users. However, "License" is not something that most users need to access frequently. The license information will also be available on the Overview page (#4786).
I think Leo has access to the Google Analytics data.
The "Improve this page" button is mainly intended for documentation improvements and does not cover bug reports. The idea is that when users encounter problems while using PyGMT, they may first consult the documentation, then either ask questions on the GMT forum if they need help, or open an issue if they believe they have found a bug. Currently, we provide a link to the "Source Code", but for users who are not familiar with GitHub, it may not be obvious how to report bugs. Therefore, I think adding a dedicated "Issue Tracker" or "Bug Report" link would make it easier for users to find the appropriate channel. |
Description of proposed changes
Separat PR for xref: #4762
Sofar I could not finde were the section heading can be changed from "Getting Help and Contributing" to something else. In this case to "Getting Help". (Currently the icons are not exactly the same.)
"License" does not exactly fit under this section, but I think we should list it somewhere. And at the moment I think it fits best in this section. Edit: Maybe we can include it into the footer ? Off Topic: Were are these "Google Analytics" data available?
BTW we already have the "Improve this page" button in the upper right corner.
Fixes #
Preview:
Guidelines
Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code