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

Regroup tutorials into four categories #2109

Merged
merged 3 commits into from
Jan 18, 2024

Conversation

mabelzhang
Copy link
Contributor

@mabelzhang mabelzhang commented Sep 1, 2023

🎉 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

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

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.

@mabelzhang mabelzhang added documentation Improvements or additions to documentation beta Targeting beta release of upcoming collection labels Sep 1, 2023
@codecov
Copy link

codecov bot commented Sep 1, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (451dcf3) 65.66% compared to head (59b777f) 65.66%.

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.
📢 Have feedback on the report? Share it here.

@mabelzhang mabelzhang marked this pull request as ready for review September 1, 2023 19:59
@mabelzhang
Copy link
Contributor Author

Ready for review

Signed-off-by: Mabel Zhang <[email protected]>
@mabelzhang mabelzhang removed the beta Targeting beta release of upcoming collection label Oct 18, 2023
@mabelzhang
Copy link
Contributor Author

@azeey Do you want to take a look at this PR or is the green check good?

Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mabelzhang mabelzhang merged commit 0f27ce0 into main Jan 18, 2024
5 of 8 checks passed
@mabelzhang mabelzhang deleted the mabelzhang/tutorials_4_categories branch January 18, 2024 03:14
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
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants