gmt
gmt copied to clipboard
Possible updates to the documentation
Looking at the documentation webpage sidebar I had these thoughts:
Under Getting Started we have
Example Gallery
Animations
Tutorial
Tutorial in Julia
The first two are both galleries of sorts. Both are examples as well, so the naming is a bit inconsistent to me. Then there is a tutorial and another one in Julia. What is the first in, one may ask, etc. My suggestion:
Illustration Gallery Animation Gallery Tutorial in bash Tutorial in Julia
[Might there be on in PyGMT?] How about GMT/MEX? Maybe for the latter we should add a link to the pre-publication version of the GMT/MEX G-cubed paper (which we foolishly did not do Open Access).
Next is Reference Documentation. Pretty good, but would not the API and PostScriptLight documentation fit in better here as well?
Finally, Development seems to mix actual development things with aspects of governance. Maybe these should be separated out better? Maybe a separate About section that is moved to the top?
All good points, Paul. There's also the user script contributions page - https://docs.generic-mapping-tools.org/dev/users-contrib-scripts.html. Since there's only one this could either merged into examples or moved to the showcase on the forum. But does that example still work? I'm not sure based on https://forum.generic-mapping-tools.org/t/vertical-slice-in-a-3d-map/2875, but haven't checked.
Regarding a PyGMT tutorial, I think it would be better to have a link to the product of https://github.com/GenericMappingTools/pygmt/issues/770 hosted in the PyGMT docs rather than maintain tutorials in Python in multiple places. It would be easy to have link work with your suggestion of a 'Tutorial in Python' item in the sidebar.
Regarding development versus governance, do we have anywhere public that lays out the governance tasks to be accomplished as part of the NSF grant? I think the governance documentation would be most effectively discussed in that context.
Under getting started, I would add a link to installation instructions, even if it just redirects to https://github.com/GenericMappingTools/gmt/blob/master/INSTALL.md.