DOC: Reorganize subsection "Overview" (website) and README (GitHub repo) - #4786
DOC: Reorganize subsection "Overview" (website) and README (GitHub repo)#4786yvonnefroehlich wants to merge 12 commits into
Conversation
yvonnefroehlich
added
documentation
| our [Discourse forum](https://forum.generic-mapping-tools.org/c/questions/pygmt-q-a). | ||
|
|
||
|
|
||
| ## Support |
There was a problem hiding this comment.
I still think we should not include any content from README, so that README and the landing page are fully decoupled.
There was a problem hiding this comment.
Jupp, I made several changes, including removing "Support", "Min Supp Versions", "Related Projects".
For now, I also removed "Project goals" and moved it to the documentation.
… README and add links to docs
| visit the [Gallery](https://www.pygmt.org/latest/gallery), and check out some | ||
| [external PyGMT examples](https://www.pygmt.org/latest/external_resources.html)! | ||
|
|
||
| [](https://www.youtube.com/watch?v=4iPnITXrxVU) |
There was a problem hiding this comment.
For me, this preview image is currently too large and dominant in the README. Maybe we can reduce the size. Or remove it as it is actually from SciPy 2022 and thus already four years old.
yvonnefroehlich
changed the title
| **BSD 3-clause License**. A copy of this license is provided in | ||
| [LICENSE.txt](https://github.com/GenericMappingTools/pygmt/blob/main/LICENSE.txt). | ||
|
|
||
| ## Support |
There was a problem hiding this comment.
After #4762, README.md is no longer used as the landing page. Its primary purpose is now to help users understand the project. I think "Funding" and "Related projects" provide useful information for users who are interested in the project and its code, so I suggest keeping them in the README.
Although this means duplicating the information in both the README and the overview page, these sections are relatively static and unlikely to require frequent updates. Therefore, I think the maintenance cost of this duplication is minimal and acceptable.
In other words, I feel you can revert changes in README, so that this PR can focus on the overview page.
As for the "Minimum supported versions" section, many projects have a "Dependency" section (e.g., https://github.com/pandas-dev/pandas#dependencies, https://github.com/geopandas/geopandas#install), I feel we can add a similar section listing the dependencies, then refer users to the "Minimum Supported Versions" page (https://www.pygmt.org/dev/minversions.html) for more information.
Anyway, it should be done in separate PRs.
2 participants
Description of proposed changes
Wait for
Related to #4746
Fourth PR related to comment https://github.com/GenericMappingTools/pygmt/pull/4762/changes#r3663485282
See also the suggestions at #4762 (comment) regarding the README.
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