-
Notifications
You must be signed in to change notification settings - Fork 269
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
Regroup tutorials into four categories #2109
Conversation
Signed-off-by: Mabel Zhang <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2109 +/- ##
=======================================
Coverage 65.66% 65.66%
=======================================
Files 324 324
Lines 30938 30938
=======================================
+ Hits 20314 20315 +1
+ Misses 10624 10623 -1 ☔ View full report in Codecov by Sentry. |
Ready for review |
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Michael Carroll <[email protected]>
@azeey Do you want to take a look at this PR or is the green check good? |
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.
LGTM!
🎉 New feature
Plenty of room for feedback on the groupings
Summary
Regroup tutorials into the 4 categories (tutorials, how-to guides, explanation, reference) recommended by the best-practice guide for documentation here https://documentation.divio.com/ which is followed by the ROS 2 documentation, as mentioned in this comment: #2028 (review)
(Also fix a few formatting problems I saw here and there)
Test it
Preview the rendered Doxygen pages in
build/gz-sim8/doxygen/html/tutorials.html
Checklist
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.