Update Tutorials setup - #10
Merged
Merged
Conversation
Signed-off-by: Francisco Martín Rico <fmrico@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation/howtos to unify the “Setup” sections across tutorials, clarify which components are core vs plugin packages, and standardize the example workspace path to ~/easynav_ws.
Changes:
- Standardize tutorial setup steps to point to
build_install/indexand explicitly list required plugin packages (APT/Pixi) vs source builds. - Update multiple howtos to use a consistent workspace path (
~/easynav_ws) and consistent cloning guidance for demo repositories. - Refresh supported ROS 2 distro references (including adding “lyrical” to the visible docs) and fix the developer guide anchor.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
plugins/index.rst |
Updates supported ROS 2 versions list and badge section; adds pointer to install matrix. |
howtos/simple_navigating.rst |
Adds a consolidated Setup section including plugin install commands and repo cloning steps. |
howtos/simple_mapping.rst |
Reworks Setup section to align with unified install flow and plugin installation. |
howtos/serest_controller.rst |
Clarifies that SeReST is a plugin and provides installation paths (APT/Pixi/source). |
howtos/routes_costmap_manager.rst |
Adds Setup section with required plugin packages per install method. |
howtos/ros2_easynav_cli.rst |
Clarifies CLI packaging (core easynav_tools) and points to install docs. |
howtos/patrolling_behavior.rst |
Unifies setup steps, plugin install commands, and workspace paths. |
howtos/index.rst |
Consolidates “Bonxai” and “NavMap” headings into a combined stack section. |
howtos/gridmap_navigating.rst |
Unifies setup and plugin install commands; updates workspace paths. |
howtos/gridmap_mapping.rst |
Unifies setup with explicit plugin installation and adds an internal section anchor. |
howtos/docker_crossdistro.rst |
Adds note clarifying cross-distro build/install options (source vs APT). |
howtos/custom_perception_plugin.rst |
Reworks setup to explicitly build from source and lists required repos. |
howtos/costmap_navigating.rst |
Unifies setup with plugin install commands and updated workspace paths. |
howtos/costmap_navigating_with_icreate.rst |
Adds distro/source-build note; adjusts clone commands and package list. |
howtos/costmap_multirobot.rst |
Unifies setup, plugin install commands, workspace paths, and launch snippets. |
howtos/costmap_mapping.rst |
Unifies setup to explicitly require costmap maps manager plugin. |
howtos/bonxai_navmap_from_rosbag.rst |
Adds Setup section with required plugin packages and sourcing guidance. |
developer_guide/index.rst |
Fixes the developer guide label/anchor for linking. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+28
to
33
| .. image:: https://img.shields.io/badge/ROS%202-rolling-blue | ||
| :alt: ROS 2 rolling | ||
| :target: # | ||
| .. image:: https://img.shields.io/badge/ROS%202-lyrical-blue | ||
| :alt: ROS 2 lyrical | ||
| :target: # |
Comment on lines
+54
to
+58
| cd ~/easynav_ws | ||
| rosdep install --from-paths src --ignore-src -y -r | ||
| colcon build --symlink-install | ||
| source /opt/ros/<distro>/setup.bash | ||
| source install/setup.bash |
Comment on lines
+29
to
+32
| Complete the installation steps in :doc:`../build_install/index` first (any of APT, | ||
| Pixi or source). This tutorial's example configuration uses the **SeReST | ||
| Controller**, **Simple Localizer**, **Simple Maps Manager** and **Simple Planner** | ||
| plugins, which the core ``easynav`` package does not include: |
| git clone https://github.com/EasyNavigation/easynav_playground_kobuki.git | ||
|
|
||
| Build and source the workspace: | ||
| Build and source the workspace as described in :ref:`gs_source_workspace`: |
Comment on lines
+42
to
+46
| Before starting, complete the installation steps in :doc:`../build_install/index` | ||
| (any of APT, Pixi or source). The navigation stack launched below | ||
| (``costmap.serest.params.yaml``) uses the **SeReST Controller**, **Costmap | ||
| Localizer**, **Costmap Maps Manager** and **Costmap Planner** plugins, which the | ||
| core ``easynav`` package does not include: |
Comment on lines
+26
to
+29
| Complete the installation steps in :doc:`../build_install/index` first (any of APT, | ||
| Pixi or source). The examples below use the **Costmap Maps Manager**, **Routes Maps | ||
| Manager**, **SeReST Controller**, **Costmap Localizer** and **Costmap Planner** | ||
| plugins, which the core ``easynav`` package does not include: |
Comment on lines
+19
to
+22
| Before starting, complete the installation steps in :doc:`../build_install/index` | ||
| (any of APT, Pixi or source). This tutorial's example configuration uses the | ||
| **SeReST Controller**, **Costmap Localizer**, **Costmap Maps Manager** and | ||
| **Costmap Planner** plugins, which the core ``easynav`` package does not include: |
Comment on lines
+56
to
61
| Build and source the workspace as described in :ref:`gs_source_workspace`: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| cd ~/easynav_ws | ||
| colcon build --symlink-install |
Comment on lines
+31
to
+34
| Before starting, complete the installation steps in :doc:`../build_install/index` | ||
| (any of APT, Pixi or source). This tutorial's example configuration uses the | ||
| **Simple Controller**, **Costmap Localizer**, **Costmap Maps Manager** and | ||
| **Costmap Planner** plugins, which the core ``easynav`` package does not include: |
| git clone https://github.com/EasyNavigation/easynav_playground_kobuki.git | ||
| git clone https://github.com/EasyNavigation/easynav_indoor_testcase.git | ||
|
|
||
| Then build and source the workspace as described in :ref:`gs_source_workspace`: |
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.
Hi,
After #9 , more updates are needed, mainly for unifiying the setup step in the howtos
I hope it helps