-
Notifications
You must be signed in to change notification settings - Fork 219
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
Reorganize tutorial section in the documentation sidebar #1603
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Makes the whole structure much more tidy!
This looks like a good idea (and reminds me that I need to motivate to work on #770 😬 ) |
I agree with putting "Gallery", "Projections", "Tutorials" and "External Resources" in the "USER GUIDE" part, but I don't like the subfolder structure for the tutorials. For any new tutorials, we may waste time debating if a tutorial belongs to the "beginner", "intermediate", or "advanced" groups. Personally, I prefer to have all tutorials in the same folder. |
Maybe take the middle ground and just have 2 sections (Basics and Advanced as suggested by @core-man in #1191 (comment))? I do think there's a bit of subjectivity on what counts as beginner/intermediate/advanced, so better to make things more simple. |
I consolidated intermediate and advanced tutorials and added to the contributing guide that new tutorials should go in |
Should we put "Tutorials" at the top of the "User Guide" section? That would be my pick; I think it should be at the top of the section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @meghanrjones! Just some comments.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Can we merge this PR now? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes please, go for it!
…ingTools#1603) Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Description of proposed changes
This PR implements the suggestions proposed in #1191 using a folding structure with beginner, intermediate, and advanced sections for the various tutorials.
Here is the appearance with one of the sections expanded:
Fixes #1191
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version