Skip to content

DOC/website: Adjust order of subsections under 'Getting Help' in sidebar - #4799

Merged
seisman merged 7 commits into
mainfrom
adjust-order-sidebar-gettinghelp
Aug 6, 2026
Merged

DOC/website: Adjust order of subsections under 'Getting Help' in sidebar#4799
seisman merged 7 commits into
mainfrom
adjust-order-sidebar-gettinghelp

Conversation

@yvonnefroehlich

@yvonnefroehlich yvonnefroehlich commented Aug 6, 2026

Copy link
Copy Markdown
Member

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.)

sidebar (this PR #4799) card (PR #4762)
image image

"Code of Conduct" may be revelant to "Getting Help", but "License" isn't.

"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?

image

Maybe "Issue Tracker" or "Bug report" linking to https://github.com/GenericMappingTools/pygmt/issues makes more sense here?

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 perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added this to the 0.20.0 milestone Aug 6, 2026
@yvonnefroehlich yvonnefroehlich self-assigned this Aug 6, 2026
@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Aug 6, 2026
@seisman

seisman commented Aug 6, 2026

Copy link
Copy Markdown
Member

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".

<span class="caption-text">Getting help and contributing</span>

@seisman

seisman commented Aug 6, 2026

Copy link
Copy Markdown
Member

"Code of Conduct" may be revelant to "Getting Help", but "License" isn't.

"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 ?

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).

Off Topic: Were are these "Google Analytics" data available?

I think Leo has access to the Google Analytics data.

Maybe "Issue Tracker" or "Bug report" linking to https://github.com/GenericMappingTools/pygmt/issues makes more sense here?

BTW we already have the "Improve this page" button in the upper right corner.

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.

@yvonnefroehlich

Copy link
Copy Markdown
Member Author

The license information will also be available on the Overview page (#4786).

I think it makes sense to add a section "License" to the overview page (so far we do not have one there). Removed it from the sidebar in commit 6f82b5d.

Comment thread doc/conf.py
@seisman
seisman merged commit 4f53f6d into main Aug 6, 2026
5 of 10 checks passed
@seisman
seisman deleted the adjust-order-sidebar-gettinghelp branch August 6, 2026 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants