search

GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
760 stars 220 forks source link

Redesign the tutorial section on the documentation sidebar #1191

Closed seisman closed 3 years ago

seisman commented 3 years ago

We already have a long list of tutorials in the "User Guide" part. I expect more tutorials will be added in the future, and the length of the sidebar will increase. I think we need to think about how to reorganize the learning material and how to shorten the sidebar.

image

michaelgrund commented 3 years ago

Is it possible to add some folding here? E.g. unfold the individual tutorials only after clicking on "User Guide".

weiji14 commented 3 years ago

Is it possible to add some folding here? E.g. unfold the individual tutorials only after clicking on "User Guide".

Agree with having some folding, but how should we organize it? Beginner/Intermediate/Advanced? Or something more semantic like Basemaps/Plotting items/Grids?

Xref geopandas which did a restructure last year (see https://github.com/geopandas/geopandas/issues/1505), perhaps we could get some inspiration from.

maxrjones commented 3 years ago

I agree with the folding ideas and like the semantic naming of sub-sections.

I would actually prefer that the section in its entirety be called 'tutorials' rather than 'user guide' because that seems more descriptive and aligns with how that section of the documentation is typically referred to in conversation.

core-man commented 3 years ago

Is it possible to add some folding here? E.g. unfold the individual tutorials only after clicking on "User Guide".

Agree with having some folding, but how should we organize it? Beginner/Intermediate/Advanced? Or something more semantic like Basemaps/Plotting items/Grids?

Yes, I'm also wondering if we could have two kinds of tutorials: Beginner and Advanced. The Beginner could be included in Get Started section and is named as PyGMT 101 or something else, while the original User Guide section is renamed to be Advanced. See a quick example below to check how it may look like. In this example, the projection is an individual subsection since I think it covers too much, while the Basics subsection contains a few advanced tutorials.

pygmt

Then we may think that which tutorials should be included in PyGMT 101 and which in Advanced/Basics. From my point of view, the following tutorials could be within PyGMT 101 because it seems they are often used in the usual plotting.