Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redesign the tutorial section on the documentation sidebar #1191

Closed
seisman opened this issue Apr 7, 2021 · 4 comments · Fixed by #1603
Closed

Redesign the tutorial section on the documentation sidebar #1191

seisman opened this issue Apr 7, 2021 · 4 comments · Fixed by #1603
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated
Milestone

Comments

@seisman
Copy link
Member

seisman commented Apr 7, 2021

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

@seisman seisman added the question Further information is requested label Apr 7, 2021
@michaelgrund
Copy link
Member

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

@weiji14
Copy link
Member

weiji14 commented Apr 9, 2021

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 geopandas/geopandas#1505), perhaps we could get some inspiration from.

@weiji14 weiji14 changed the title Redesign the documentation sidebar Redesign the tutorial section on the documentation sidebar Apr 9, 2021
@maxrjones
Copy link
Member

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
Copy link
Member

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.

  • Frames, ticks, titles, and labels
  • Coastlines and borders
  • Plotting data points
  • Plot lines
  • Plotting text
  • Plotting Earth relief
  • Adding an inset to the figure
  • Making subplots

@weiji14 weiji14 added documentation Improvements or additions to documentation help wanted Helping hands are appreciated and removed question Further information is requested labels May 31, 2021
@seisman seisman added this to the 0.6.0 milestone Nov 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants