arrow_backRetour aux issues
GenericMappingTools/pygmt
#4810
Débutant
Ouvrirarrow_forward
Débutant
Ouvrirarrow_forward
Débutant
Ouvrirarrow_forward
Improve PyGMT documentation usability and consistency
ecoDébutant
documentation
help wanted
discussions
descriptionDescription
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 f8d331fd" 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.
- [ ] Improve the ["Full installation"](https://www.pygmt.org/dev/install.html) page
- [ ] 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.
- [x] List both required and optional dependencies (#4807).
- [ ] Improve the ["PyGMT Ecosystem"](https://www.pygmt.org/dev/ecosystem.html) page
- [ ] 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](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#syntax-glossaries) with shorter descriptions to make the page more concise.
- [x] Redesign the ["Presentations"](https://www.pygmt.org/dev/presentations.html) page using the card layout (#4805).
- [ ] Improve the ["Changelog"](https://www.pygmt.org/dev/changes.html) page. Contributors are currently listed using Markdown lists, which takes up significant vertical space, especially in the [PDF documentation](https://www.pygmt.org/dev/pygmt-docs.pdf)(~700 pages). Consider using a comma-separated list instead, e.g., `Author1, Author2, Author3`.
- [ ] Improve visibility of the PDF documentation. The PDF documentation has been available since v0.15.0 (#1606), although there are still some limitations (#3813). Currently, the dev PDF is available at https://www.pygmt.org/dev/pygmt-docs.pdf, and release PDFs are attached as release assets. Consider ways to make the PDF documentation easier to discover.
- [ ] Improve the ["PyGMT Team"](https://www.pygmt.org/dev/team.html) 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.
Issues similaires
calkit/calkit
star53
Poids du dépôt moyen
VS Code extension should be robust to YAML parser errors
Seeing this error: ``` Failed to read calkit.yaml: YAMLParseError: A block sequence may not be used as an implicit map…
Python
bug
good first issue
fu351/Doberman-Core
star211
Poids du dépôt léger
dash: a manual Refresh control
The dashboard polls: `refreshStats()` (`src/doberman/dash/app.py:408`) every 5 s and `refreshPending()` (`:546`) every …
Python
enhancement
good first issue
fu351/Doberman-Core
star211
Poids du dépôt léger
dash: "Copy details" button on each pending-approval card
Each pending-approval card in the dashboard (`renderPending`, `src/doberman/dash/app.py:448-544`) shows the risk badge,…
Python
enhancement
good first issue