You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
After redesigning the PyGMT documentation landing page and the project README (#4746), I feel it is a good time to further improve the documentation. Below are some documentation issues and ideas that we can discuss and address.
Improve version information shown in the footer. At the site footer, the dev version shows "Revision f8d331f" and the release version shows "Revision v0.19.0". I think it would be clearer to show "Release 0.19.0" instead of "Revision v0.19.0" for release versions.
Add an introductory note at the beginning, for example:
The "Quickstart" section provides the fastest way to install PyGMT, whereas the following sections provide more detailed, step-by-step instructions for users with different setups or those who want to install the latest development version.
The page currently starts with "PyGMT provides a Python interface ...", which duplicates the Overview page. Since readers of this page likely already know what PyGMT is, this sentence could be removed.
The PyGMT Ecosystem includes both dependencies of PyGMT and packages that depend on PyGMT. The current introduction only describes the former, so the wording should be updated.
The ecosystem figure currently only shows PyGMT dependencies. Consider moving it to the "PyGMT dependencies" section.
Add GMT as a PyGMT dependency.
Currently, each package uses its name as a level-3 heading and includes the full official project description. Consider using MyST definition lists with shorter descriptions to make the page more concise.
Improve the "Changelog" page. Contributors are currently listed using Markdown lists, which takes up significant vertical space, especially in the PDF documentation(~700 pages). Consider using a comma-separated list instead, e.g., Author1, Author2, Author3.
Improve the "PyGMT Team" page. The page currently starts with four paragraphs of introductory text, which may be longer than necessary. Consider shortening it or moving some of the content into individual subsections.
After redesigning the PyGMT documentation landing page and the project README (#4746), I feel it is a good time to further improve the documentation. Below are some documentation issues and ideas that we can discuss and address.
Author1, Author2, Author3.