-
Notifications
You must be signed in to change notification settings - Fork 277
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
Categorize tutorials list #2028
Conversation
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Codecov Report
@@ Coverage Diff @@
## gz-sim7 #2028 +/- ##
===========================================
- Coverage 65.02% 65.00% -0.03%
===========================================
Files 354 354
Lines 28636 28636
===========================================
- Hits 18621 18615 -6
- Misses 10015 10021 +6 |
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.
This looks really great, thanks! I have just one minor comment about a heading.
I was also talking to Chris about this and he suggested the idea of documentation having four parts: concepts, tutorials, API, and how-to guides. I've also found https://documentation.divio.com/ and https://docs-guide.readthedocs.io/en/latest/doctypes/ that more or less align with those. Maybe we can start thinking about our documentation in these terms.
Signed-off-by: Mabel Zhang <[email protected]>
Yeah, he told me about those 4 categories they incorporated for ROS 2 docs. We should brainstorm a bit about that... |
🎉 New feature
Categorize tutorials so that it’s easier for users to find what they need. (Also fixed formatting inconsistencies as I clicked through all the tutorials.)
Previously, all the tutorials were in a big list of arbitrary order. As the number of tutorials grew, we continued to add to the list but did not index them in a digestible way.
This PR doesn’t aim for a perfect categorization. It’s just a “better” categorization than what it is now - any categorization is better than no categorization.
It can always be modified or refined again later.
Summary
I just went down the list and looked for what natural groupings there were. The way I structured the page is meant to go in a general progression from beginner, intermediate, advanced users, to developers. Aside from that, there were sets of tutorials for GUI, Blender, and very very specific tutorials for one system plugin that only some users would find useful, so I grouped them accordingly.
Open to feedback.
Test it
Preview the rendered Doxygen pages in
build/gz-sim7/doxygen/html/tutorials.html
Checklist
Added testsUpdated migration guide (as needed)Consider updating Python bindings (if the library has them)codecheck
passed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-by
messages.