Skip to content

[Rolling] Migrate Nav2 Documentation from Sphinx to MkDocs - #949

Merged
SteveMacenski merged 473 commits into
ros-navigation:rollingfrom
AJedancov:mkdocs-nav2-rolling-2
Aug 25, 2026
Merged

[Rolling] Migrate Nav2 Documentation from Sphinx to MkDocs#949
SteveMacenski merged 473 commits into
ros-navigation:rollingfrom
AJedancov:mkdocs-nav2-rolling-2

Conversation

@AJedancov

Copy link
Copy Markdown
Contributor

No description provided.

… with macro for dynamic rendering

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
…CancelCoverage, ComputeCoveragePath, DockRobot and UndockRobot pages

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
…oved readability

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Update documentation for deceleration max for Graceful Controller"
Authors of original commit:
Sakshay Mahna <sakshum19@gmail.com>
Steve Macenski <stevenmacenski@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Adaptive tolerance goal checker"
Author of original commit: David G <david.randommail1@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Adding low acceleration parameter adjustments"
Author of original commit: SteveMacenski <stevenmacenski@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Specify behavior of RecoveryNode on recovery failure"
Author of original commit: Jonas Otto <jonas@jonasotto.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Remove stateful parameter from RPP"
Author of original commit: Maurice Alexander Purnawan <mauricepurnawan@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Update configuring-mppic.rst"
Author of original commit: Steve Macenski <stevenmacenski@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Removing Rover as Friends of Nav2 sponsor :("
Author of original commit: SteveMacenski <stevenmacenski@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "added max_cost_threshold parameter for rotation shim"
Author of original commit: alireza-moayyedi

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Tutorial for Ground Consistency Layer"
Author of original commit: haider8645 <haider_lodhi@hotmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Feature/clear individual costmap layers"
Author of original commit: Sushant Chavan <gitecsvc@gmail.com>

Note: port configuration documentation is now generated automatically based on data from nav2 project, so this part of commit has not been included
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
- simplify exception messages
- disable information capture during cloning
- combine clone and sparse-checkout commands into single try block and remove created directory if exception occurs

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
SteveMacenski and others added 27 commits August 22, 2026 11:13
* Adding ros2 distro variable for scalability of distribution support

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Adding progress bar to roadmap page

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Changing roadmap task size

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Adding lyrical to the homepage

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Move related projects to other page

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Adding missing roscon talk

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* refactor roscon talk page and citations slightly

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Landing page updates

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Adding midding table entries

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Fix button formatting

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

---------

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>
Title: "Fix typo in navigation2_with_sam3 documentation"
Author of original commit: Steve Macenski <stevenmacenski@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "Document NavFn max_cycles_factor"
Author of original commit: Jiarui Zou <jiarui_zou@outlook.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
* New cards for pages with icons

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* note card use nav2 blue

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Add missing features and cleanup entry text

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

* Update overrides/assets/stylesheets/nav_buttons.css

Co-authored-by: Andrei Jedancov <56676753+AJedancov@users.noreply.github.com>
Signed-off-by: Steve Macenski <stevenmacenski@gmail.com>

* fix search and replace

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>

---------

Signed-off-by: SteveMacenski <stevenmacenski@gmail.com>
Signed-off-by: Steve Macenski <stevenmacenski@gmail.com>
Co-authored-by: Andrei Jedancov <56676753+AJedancov@users.noreply.github.com>
This reverts commit bf349de507b2a5797ae687074f4050d2d91e88b1.

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "docs(costmap-filters): add Zone Parameter Filter configuration page"
Authors of original commit:
Akihiko Komada <aki1770@gmail.com>
Steve Macenski <stevenmacenski@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
ros-navigation#37)

* docs: describe shared pages usage in Docs Distribution Release Process

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

* docs: remove homepage from sync process

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

* docs: include complete configuration example for .nav.yml

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

* docs: update steps for symlink compliance

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

* docs: include images and videos for homepage in sync process

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

* docs: supplement note with necessary changes

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

* docs: update edit_uri link

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

---------

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
* docs: expand and clarify maintenance notes

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

* docs: explain how to update BT Node ports and XML examples

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>

---------

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "docs(zone_parameter_filter): add demo GIF to configuration and migration pages"

Author of original commit: Akihiko Komada <aki1770@gmail.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
Title: "docs(axis_goal_checker): update description and add direction estimation distance parameter"

Author of original commit: Tony Najjar <tony.najjar@dexory.com>

Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
@mergify

mergify Bot commented Aug 25, 2026

Copy link
Copy Markdown

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@SteveMacenski
SteveMacenski merged commit 80c439c into ros-navigation:rolling Aug 25, 2026
6 of 7 checks passed
@AJedancov
AJedancov deleted the mkdocs-nav2-rolling-2 branch August 26, 2026 07:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants