docs: describe shared pages usage in Docs Distribution Release Process - #37
Open
AJedancov wants to merge 3 commits into
Open
docs: describe shared pages usage in Docs Distribution Release Process#37AJedancov wants to merge 3 commits into
AJedancov wants to merge 3 commits into
Conversation
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
SteveMacenski
approved these changes
Aug 10, 2026
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
AJedancov
force-pushed
the
docs/describe-shared-pages-usage
branch
from
August 11, 2026 13:12
177bf2b to
dd32409
Compare
Comment on lines
+117
to
+141
| - Home: | ||
| # The Home page displays the first two levels of the navigation structure | ||
| # with manually specified links to each page for quick access. | ||
| # Update this section whenever the documentation directory structure or page order changes. | ||
| - index.md | ||
| - Getting Started: | ||
| - getting_started/index.md | ||
| - Quickstart: getting_started/quickstart/quickstart.md | ||
| - Build and Install: getting_started/build_and_install/index.md | ||
| - Dev Container: getting_started/dev_container/index.md | ||
| - Navigation Concepts: getting_started/navigation_concepts/index.md | ||
| - Nav2 Behavior Trees: getting_started/nav2_behavior_trees/index.md | ||
| - Tutorials: | ||
| - tutorials/index.md | ||
| - Plugin Tutorials: tutorials/plugin_tutorials/index.md | ||
| - General Tutorials: tutorials/general_tutorials/index.md | ||
| - Configuration & Development: | ||
| - configuration_and_development/index.md | ||
| - First-Time Robot Setup Guide: configuration_and_development/first_time_robot_setup_guide/index.md | ||
| - Navigation Plugins: configuration_and_development/navigation_plugins.md | ||
| - Configuration Guide: configuration_and_development/configuration_guide/index.md | ||
| - Tuning Guide: configuration_and_development/tuning_guide.md | ||
| - Simple Commander API: configuration_and_development/simple_commander_api/simple_commander_api.md | ||
| - Migration Guides: configuration_and_development/migration_guides/index.md | ||
| - API Docs: https://api.nav2.org/ |
Member
There was a problem hiding this comment.
Suggested change
| - Home: | |
| # The Home page displays the first two levels of the navigation structure | |
| # with manually specified links to each page for quick access. | |
| # Update this section whenever the documentation directory structure or page order changes. | |
| - index.md | |
| - Getting Started: | |
| - getting_started/index.md | |
| - Quickstart: getting_started/quickstart/quickstart.md | |
| - Build and Install: getting_started/build_and_install/index.md | |
| - Dev Container: getting_started/dev_container/index.md | |
| - Navigation Concepts: getting_started/navigation_concepts/index.md | |
| - Nav2 Behavior Trees: getting_started/nav2_behavior_trees/index.md | |
| - Tutorials: | |
| - tutorials/index.md | |
| - Plugin Tutorials: tutorials/plugin_tutorials/index.md | |
| - General Tutorials: tutorials/general_tutorials/index.md | |
| - Configuration & Development: | |
| - configuration_and_development/index.md | |
| - First-Time Robot Setup Guide: configuration_and_development/first_time_robot_setup_guide/index.md | |
| - Navigation Plugins: configuration_and_development/navigation_plugins.md | |
| - Configuration Guide: configuration_and_development/configuration_guide/index.md | |
| - Tuning Guide: configuration_and_development/tuning_guide.md | |
| - Simple Commander API: configuration_and_development/simple_commander_api/simple_commander_api.md | |
| - Migration Guides: configuration_and_development/migration_guides/index.md | |
| - API Docs: https://api.nav2.org/ | |
| # ... Main website ... |
Collaborator
Author
There was a problem hiding this comment.
I'm working on an approach that doesn't require changes to the .nav config. I'd like to keep this PR unchanged while complete the testing.
Comment on lines
+154
to
+156
| - Getting Started: getting_started | ||
| - Tutorials: tutorials | ||
| - Configuration & Development: configuration_and_development |
Member
There was a problem hiding this comment.
Aren't these before the Community/Robots Using/About & Contact?
If so, remove as well
Member
There was a problem hiding this comment.
I just wanted the full list of the shared docs pages
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
2 participants
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.
Basic Info
Description of contribution in a few bullet points
Added steps required to synchronize shared pages against the Rolling branch.