-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
convert navigation2 tutorials to rst format for github pages #1428
Conversation
- change titles
…tree. Created index.rst for tutorials
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.
Just some rewording, comment inline and we can discuss
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_with_turtlebot3_in_gazebo.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_with_turtlebot3_in_gazebo.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_with_turtlebot3_in_gazebo.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_on_real_turtlebot3.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_with_turtlebot3_in_gazebo.rst
Outdated
Show resolved
Hide resolved
sphinx_doc/howtos/tutorials/docs/navigation2_with_turtlebot3_in_gazebo.rst
Show resolved
Hide resolved
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.
Personally I prefer not to use "I" , "you", "we" in technical documents. This document is written in a second person narrative with too many "you"s. I will approve, if that's okay with you.
These are just tutorials, so I picked this language to give the user the feeling that "we" go through each step together. I didn't want this to sound like a boring product manual that no one ever reads :) |
Codecov Report
@@ Coverage Diff @@
## master #1428 +/- ##
==========================================
- Coverage 40.28% 38.59% -1.69%
==========================================
Files 229 229
Lines 11765 11765
Branches 5074 5074
==========================================
- Hits 4739 4541 -198
- Misses 3627 3872 +245
+ Partials 3399 3352 -47
Continue to review full report at Codecov.
|
I think the only thing left from my review is the turtlebot links |
Converted the following tutorials to rst format. - Navigation2 on a Real Turtlebot 3 - Navigation2 with Turtlebot 3 in Gazebo - Copied the documentation images to sphinx_doc directory.
Manually converted the following tutorials to rst format.
Copied the doc images to sphinx_doc directory.
Changes in PR #1393 may affect this PR. (doc tree and links etc)