-
Notifications
You must be signed in to change notification settings - Fork 180
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
adding dwb param descriptions #31
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.
I can't find this in the generated website, where is this work?
Co-authored-by: Steve Macenski <stevenmacenski@gmail.com>
I think you should split the main page into 4 pages: dwb controller, iterator, kinematic parameters, visualization - along with the other separated pages. Its just too long. I think the main landing page here should just be a list of links to the other pages and then the full example below it. The DWB main-controller parameters should be first, then the other 3 on this main page, then the others you have listed. |
@@ -1,11 +1,13 @@ | |||
.. dwb_iterator: | |||
.. _dwb_iterator: | |||
|
|||
Iterator |
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 think this is the XYTheta iterator, not just the generic iterator.
@@ -1,11 +1,13 @@ | |||
.. dwb_kinematic_params: | |||
.. _dwb_kinematic_params: | |||
|
|||
Kinematics |
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 should also be the full name like the iterator page. Kinematic Parameters
@@ -1,11 +1,13 @@ | |||
.. dwb_vis: | |||
.. _dwb_vis: | |||
|
|||
Visualization |
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.
As well here, use the full name
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.
Full name for this is Publisher, right?
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.
Correct
Co-authored-by: Steve Macenski <stevenmacenski@gmail.com>
Reminder to self: post on discourse about this when this is in. Last PR before complete |
@Marwan99 please delete the https://navigation.ros.org/configuration/params/tunable-params.html |
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.
Please put as a full PR. Once we delete that one page, we can merge this and be done 😄
Looks like you have a couple of merge conflicts the draft PR was hiding |
Congrats @Marwan99! This was a big effort and we got it done in a couple weeks. What's your discourse handle? |
Thanks @SteveMacenski, appreciate your guidance and support! My discourse handle is marwan99, just created the account! |
Celebrate the small victories or no one else will :-) |
Should we tick the first item in this list? ros-navigation/navigation2#1589 (comment) |
good call, done |
per #21
All DWB param descriptions should be there now. (hardest part completed). Examples to be added.
@SteveMacenski What do think of the layout? Any suggestions on where the publish and kinematic parameters should live?