maxrjones
commented
3 years ago My preference for the location of the instructions would be in the docs, rather than contributing.md, because I think that it would make it more inviting for users to contribute how-to guides (rather than requiring users already be familiar with GMT's repository structure) and it could also serve as a ReST template for the other guides.
Description of the desired feature
There have been many recent, productive discussions about improvements to GMT's documentation, which include references to Daniele Procinda's documentation structure and how-to guides (e.g., https://github.com/GenericMappingTools/gmt/issues/3898 and https://github.com/GenericMappingTools/gmt/discussions/4678). The first step in developing the how-to guides is establishing a consistent format. The established structure/format could either be provided as a document for "how to write a GMT how-to guide" (for example, Numpy's guide) which would be included in the GMT docs or in a section of GMT's contributing document (similar to how PyGMT provides guidelines for tutorials in their contributing guide).
To do:
Are you willing to help implement and maintain this feature? Yes