Merged
Conversation
Signed-off-by: gary.bey <gary.bey@kabam.ai>
xiyuoh
requested changes
Jul 28, 2025
Member
xiyuoh
left a comment
There was a problem hiding this comment.
General thoughts:
- Recommend to remove all the bold text, since the description is pretty short anyway so we probably don't have to emphasize on every other sentence
- It could be good to move Navigation Graph Strategies to this section, since it is pretty nested and could be difficult for users to locate. Also because it's more for users who already have basic knowledge of creating nav graphs.
Since ROS 2's Tutorials and How-to Guides differ in level of complexity/user knowledge, we can apply similar guidelines to Open-RMF to consider where to place future guides.
xiyuoh
reviewed
Jul 28, 2025
Contributor
Author
|
@xiyuoh Thank you for the feedback so far. Planning to move Navigation Graph Strategies into Will aim to do so before today's Open-RMF Community Meeting. |
Contributor
Author
|
@xiyuoh Moved the aforementioned Navigation Graph Strategies section under How-to Guides. Ready for review again. |
xiyuoh
reviewed
Jul 28, 2025
xiyuoh
approved these changes
Jul 28, 2025
Contributor
Author
|
@xiyuoh Friendly ping on this for merging. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of Pull Request 🔖
This Pull Request (PR) is aimed at appending a new catch-all section called
How-to Guides, addressing the suggestion brought in in #120.Details are covered in the aforementioned issue thread.
Summary of Edits 📚
SUMMARY.md..mddocument,howto_guides.mdwith a short introduction on what the section is all about.Remarks 💬
To set a proper example of what is a good how-to guide, I will write up a article to be added under the new
How-to Guidessection within the coming weeks.