-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Revamp a couple of tf2 tutorials to flow better. #2781
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.
.
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.
I agree that the proposed additions make the flow much better. My only concern now is that headings on the same level have different number prefixes.
What I suggest to do is to firstly change the Contents depth to 2 as it is in other tf2 tutorials. This will hide low-level sections from a Contents tree.
Secondly, we will need to either change the number prefixes to the previous format or to change the heading type of the updated sections.
~~~~~~~~~~~~~~~~~ | ||
|
||
3 Build and run | ||
~~~~~~~~~~~~~~~ |
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.
Let's either change the heading type or the prefix number here and in similar places
That is, make sure we put in all the steps that need to be done, and more logically organize the sections. This should make them easier to follow. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
2095ca7
to
c2ffe9f
Compare
Thanks for the review, it is appreciated.
For both of the "Adding a Frame" tutorials, I think it makes sense to have a depth of 3 for the table of contents. That's because there are 2 separate "tasks" in these tutorials, and each task has a number of sub-tasks. So I left it at 3 for now.
You are absolutely correct about this; I didn't go through and renumber properly. I've now done that in the latest commit, so the whole thing should make a lot more sense. Please take another look when you get a chance. Thanks! |
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!
Thanks! Going ahead and merging and backporting this one. |
* Revamp a couple of tf2 tutorials to flow better. That is, make sure we put in all the steps that need to be done, and more logically organize the sections. This should make them easier to follow. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 739d840)
* Revamp a couple of tf2 tutorials to flow better. That is, make sure we put in all the steps that need to be done, and more logically organize the sections. This should make them easier to follow. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 739d840)
* Revamp a couple of tf2 tutorials to flow better. That is, make sure we put in all the steps that need to be done, and more logically organize the sections. This should make them easier to follow. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 739d840)
* Revamp a couple of tf2 tutorials to flow better. That is, make sure we put in all the steps that need to be done, and more logically organize the sections. This should make them easier to follow. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 739d840) Co-authored-by: Chris Lalancette <clalancette@openrobotics.org>
* Revamp a couple of tf2 tutorials to flow better. That is, make sure we put in all the steps that need to be done, and more logically organize the sections. This should make them easier to follow. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 739d840) Co-authored-by: Chris Lalancette <clalancette@openrobotics.org>
* Revamp a couple of tf2 tutorials to flow better. That is, make sure we put in all the steps that need to be done, and more logically organize the sections. This should make them easier to follow. Signed-off-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 739d840) Co-authored-by: Chris Lalancette <clalancette@openrobotics.org>
That is, make sure we put in all the steps that need to be
done, and more logically organize the sections. This should
make them easier to follow.
Signed-off-by: Chris Lalancette clalancette@openrobotics.org