From b16a3e55bb242cad15395732c096500866661a80 Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Tue, 16 Jun 2026 15:00:35 +0000 Subject: [PATCH 01/10] Adding About tools files --- source/About-analysis | 0 source/About-build | 0 source/About-introspection | 0 source/About-node-management | 0 source/About-package-documentation | 0 source/About-visualization | 0 6 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 source/About-analysis create mode 100644 source/About-build create mode 100644 source/About-introspection create mode 100644 source/About-node-management create mode 100644 source/About-package-documentation create mode 100644 source/About-visualization diff --git a/source/About-analysis b/source/About-analysis new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-build b/source/About-build new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-introspection b/source/About-introspection new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-node-management b/source/About-node-management new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-package-documentation b/source/About-package-documentation new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-visualization b/source/About-visualization new file mode 100644 index 00000000000..e69de29bb2d From 293bbbf396f5f9b23322bfc7267464ec0dedfe2b Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Wed, 17 Jun 2026 13:56:14 +0000 Subject: [PATCH 02/10] Adding content to Introspection --- source/About-introspection | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/source/About-introspection b/source/About-introspection index e69de29bb2d..c511fac679e 100644 --- a/source/About-introspection +++ b/source/About-introspection @@ -0,0 +1,22 @@ + +Introspection +============= + +Metadata sentence +This article + +**Area: community, contributing | Content-type: about | Experience: beginner, intermediate, expert** + +.. contents:: Table of Contents + :local: + +Summary +------- + + +Related content +--------------- + + +FAQs +---- \ No newline at end of file From f751c9ae6b92cc36a4157daa960108a4ccf24b6e Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Thu, 25 Jun 2026 10:19:43 +0000 Subject: [PATCH 03/10] adding about introspection to toctree --- source/About-analysis.rst | 0 source/About-build.rst | 0 source/About-introspection.rst | 50 ++++++++++++++++++++++++++ source/About-node-management.rst | 0 source/About-package-documentation.rst | 0 source/About-visualization.rst | 0 source/index.rst | 1 + 7 files changed, 51 insertions(+) create mode 100644 source/About-analysis.rst create mode 100644 source/About-build.rst create mode 100644 source/About-introspection.rst create mode 100644 source/About-node-management.rst create mode 100644 source/About-package-documentation.rst create mode 100644 source/About-visualization.rst diff --git a/source/About-analysis.rst b/source/About-analysis.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-build.rst b/source/About-build.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-introspection.rst b/source/About-introspection.rst new file mode 100644 index 00000000000..cce5233e25f --- /dev/null +++ b/source/About-introspection.rst @@ -0,0 +1,50 @@ +Introspection +============= + +**Area: ROS-tools | Content-type: about | Experience: beginner, intermediate, expert** + +.. contents:: Table of Contents + :local: + +Summary +------- +Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand and modify at run-time node state, parameters, flowing data, and more. + +Core ROS packages: + +* `ros2doctor `_: Command line tool to check for common misconfigurations in a ROS system. + +* `ros2launch `_: CLI tool for managing nodes. + +* `rosbag2 `_: Tool for recording and playing back data moving across topics, services and actions in a ROS application. + +* `ros2cli `_: CLI tool for introspection. + +* `RViz `_: Tool for visualization. + +* `rosdoc2 `_: Tool for documenting a ROS2 package. + + +Community-contributed packages: + +* `colcon `_: Tool for creating building a ROS 2 workspace. + +* `ament_cmake `_: Build system for CMake based packages in ROS 2. + +* `tracetools `_: Trace points for creating and debugging execution traces. + +Related content +--------------- + +More articles about introspection: + +* Example + +* Example + +FAQs +---- + +* Example + +* Example \ No newline at end of file diff --git a/source/About-node-management.rst b/source/About-node-management.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-package-documentation.rst b/source/About-package-documentation.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/About-visualization.rst b/source/About-visualization.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/index.rst b/source/index.rst index 93cbe9d2f4c..6d33f28cad5 100644 --- a/source/index.rst +++ b/source/index.rst @@ -22,6 +22,7 @@ ROS 2 Documentation Related-Projects Glossary Citations + About-introspection **The Robot Operating System (ROS) is a set of software libraries and tools for building robot applications.** From 47f31fb4f8d0e7db80ae876c4d7593aea9c23af5 Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Thu, 25 Jun 2026 16:17:04 +0000 Subject: [PATCH 04/10] add content to about tools articles --- source/About-analysis | 0 source/About-analysis.rst | 14 ++++++++++++++ source/About-build | 0 source/About-build.rst | 0 source/About-builds.rst | 15 +++++++++++++++ source/About-introspection | 22 ---------------------- source/About-introspection.rst | 6 ++++-- source/About-node-management | 0 source/About-node-management.rst | 14 ++++++++++++++ source/About-package-documentation | 0 source/About-package-documentation.rst | 15 +++++++++++++++ source/About-visualization | 0 source/About-visualization.rst | 15 +++++++++++++++ source/index.rst | 8 ++++++-- 14 files changed, 83 insertions(+), 26 deletions(-) delete mode 100644 source/About-analysis delete mode 100644 source/About-build delete mode 100644 source/About-build.rst create mode 100644 source/About-builds.rst delete mode 100644 source/About-introspection delete mode 100644 source/About-node-management delete mode 100644 source/About-package-documentation delete mode 100644 source/About-visualization diff --git a/source/About-analysis b/source/About-analysis deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/source/About-analysis.rst b/source/About-analysis.rst index e69de29bb2d..99a3cbf4a40 100644 --- a/source/About-analysis.rst +++ b/source/About-analysis.rst @@ -0,0 +1,14 @@ +Analysis +========= + +Sometimes you need tools to analyse the data from your robots to understand what it means beyond just capturing it. This article summarizes the ROS developer tools and guidance available to help with analysis. + +**Area: analysis, tools | Content-type: about | Experience: beginner, intermediate, expert** + +.. contents:: Table of Contents + :local: + +Summary +------- + +Just having a capture of the data flowing around your robots isn't enough. Analysis tools provide the ability to take the next steps and understand what that data means at the right level of abstraction. \ No newline at end of file diff --git a/source/About-build b/source/About-build deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/source/About-build.rst b/source/About-build.rst deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/source/About-builds.rst b/source/About-builds.rst new file mode 100644 index 00000000000..777ec8fed25 --- /dev/null +++ b/source/About-builds.rst @@ -0,0 +1,15 @@ +Builds +====== + +Sometimes you need to work with multiple packages together to build, share, and manage complex robotics systems efficiently. This article summarizes the ROS developer tools and guidance available to help with builds. + + +**Area: builds, tools | Content-type: about | Experience: beginner, intermediate, expert** + +.. contents:: Table of Contents + :local: + +Summary +------- + +ROS is a federated ecosystem and nearly every robotics system implemented in ROS makes use of multiple ROS packages. The build tools enable you to work with multiple packages in a single project - both packages of your own and those from the community. The build tools also enable you to share your own packages with the community. \ No newline at end of file diff --git a/source/About-introspection b/source/About-introspection deleted file mode 100644 index c511fac679e..00000000000 --- a/source/About-introspection +++ /dev/null @@ -1,22 +0,0 @@ - -Introspection -============= - -Metadata sentence -This article - -**Area: community, contributing | Content-type: about | Experience: beginner, intermediate, expert** - -.. contents:: Table of Contents - :local: - -Summary -------- - - -Related content ---------------- - - -FAQs ----- \ No newline at end of file diff --git a/source/About-introspection.rst b/source/About-introspection.rst index cce5233e25f..0e0197acf27 100644 --- a/source/About-introspection.rst +++ b/source/About-introspection.rst @@ -1,14 +1,16 @@ Introspection ============= -**Area: ROS-tools | Content-type: about | Experience: beginner, intermediate, expert** +Sometimes you need to understand what is happening inside your robot's software. This article summarizes the ROS developer tools and guidance available to help with introspection. + +**Area: introspection, tools | Content-type: about | Experience: beginner, intermediate, expert** .. contents:: Table of Contents :local: Summary ------- -Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand and modify at run-time node state, parameters, flowing data, and more. +Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand, and modify at run-time,node state, parameters, flowing data, and more. Core ROS packages: diff --git a/source/About-node-management b/source/About-node-management deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/source/About-node-management.rst b/source/About-node-management.rst index e69de29bb2d..12abe847b47 100644 --- a/source/About-node-management.rst +++ b/source/About-node-management.rst @@ -0,0 +1,14 @@ +Node management +=============== + +Sometimes you need to manage many interconnected nodes at once to reliably start, configure, and shut down your system. This article summarizes the ROS developer tools and guidance available to help with node management. + + +**Area: node management, tools | Content-type: about | Experience: beginner, intermediate, expert** + +.. contents:: Table of Contents + :local: + +Summary +------- +Complex robotics systems typically involve many interconnected nodes each with multiple parameters and interfaces. Node management helps you automate start up, configuration, and shut down of a number of ROS nodes simultaneously, via launch files. \ No newline at end of file diff --git a/source/About-package-documentation b/source/About-package-documentation deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/source/About-package-documentation.rst b/source/About-package-documentation.rst index e69de29bb2d..136261f3dcf 100644 --- a/source/About-package-documentation.rst +++ b/source/About-package-documentation.rst @@ -0,0 +1,15 @@ +Package documentation +===================== + +Sometimes you need to document your package so others can easily understand and use it through a web-browseable format. This article summarizes the ROS developer tools and guidance available to help with package documentation. + + +**Area: package documentation, tools | Content-type: about | Experience: beginner, intermediate, expert** + +.. contents:: Table of Contents + :local: + +Summary +------- + +If you are creating a new package, it is good practice to document that package for others who may use it - whether the wider community or just within your own organization. The package documentation tools enable you to easily document your package and then build that documentation source into a web-browseable version, such as those seen on index.ros.org. \ No newline at end of file diff --git a/source/About-visualization b/source/About-visualization deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/source/About-visualization.rst b/source/About-visualization.rst index e69de29bb2d..d6096fd45b1 100644 --- a/source/About-visualization.rst +++ b/source/About-visualization.rst @@ -0,0 +1,15 @@ +Visualization +============= + +Sometimes you need to visualize what your robot is sensing and planning to better develop, test, and debug your system. This article summarizes the ROS developer tools and guidance available to help with visualization. + + +**Area: visualization, tools | Content-type: about | Experience: beginner, intermediate, expert** + +.. contents:: Table of Contents + :local: + +Summary +------- + +It is much easier to develop, test, and debug a robotics system when you can understand what the robot is seeing, experiencing, and planning. Visualization tools transform the raw data from a robot into visual forms understandable by people. \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 6d33f28cad5..2a6aecfcef1 100644 --- a/source/index.rst +++ b/source/index.rst @@ -23,8 +23,12 @@ ROS 2 Documentation Glossary Citations About-introspection - - + About-analysis + About-node-management + About-builds + About-visualization + About-package-documentation + **The Robot Operating System (ROS) is a set of software libraries and tools for building robot applications.** From drivers and state-of-the-art algorithms to powerful developer tools, ROS has the open source tools you need for your next robotics project. From 3b76fbb5ef680eaf05f95d4760dca25ab8dd8c29 Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Fri, 26 Jun 2026 09:16:00 +0000 Subject: [PATCH 05/10] adding content to tools articles --- source/About-analysis.rst | 34 +++++++++++++++++++++++--- source/About-builds.rst | 32 +++++++++++++++++++++++- source/About-introspection.rst | 16 ++++++------ source/About-node-management.rst | 28 ++++++++++++++++++++- source/About-package-documentation.rst | 28 ++++++++++++++++++++- source/About-visualization.rst | 28 ++++++++++++++++++++- 6 files changed, 151 insertions(+), 15 deletions(-) diff --git a/source/About-analysis.rst b/source/About-analysis.rst index 99a3cbf4a40..10934fe547c 100644 --- a/source/About-analysis.rst +++ b/source/About-analysis.rst @@ -1,7 +1,7 @@ Analysis -========= +======== -Sometimes you need tools to analyse the data from your robots to understand what it means beyond just capturing it. This article summarizes the ROS developer tools and guidance available to help with analysis. +Sometimes you need tools to analyze the data from your robot to understand what it means. This article summarizes the ROS developer tools and guidance available to help with analysis. **Area: analysis, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -11,4 +11,32 @@ Sometimes you need tools to analyse the data from your robots to understand what Summary ------- -Just having a capture of the data flowing around your robots isn't enough. Analysis tools provide the ability to take the next steps and understand what that data means at the right level of abstraction. \ No newline at end of file +Capturing the data from your robot is just the first step. Analysis tools in ROS help you go further by making sense of that data and revealing insights at the right level of detail. + +Core ROS packages: + +* `tracetools `_: Trace points for creating and debugging execution traces. + +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? + +Community-contributed packages: + +* `Plotjugler `_: Visualization and analysis tool for inspecting, monitoring, and interpreting time-series data. + +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? + +Related content (placeholder) +--------------- + +More articles about analysis: + +* Example + +* Example + +FAQs (placeholder) +---- + +* Example + +* Example \ No newline at end of file diff --git a/source/About-builds.rst b/source/About-builds.rst index 777ec8fed25..5a5be96c65f 100644 --- a/source/About-builds.rst +++ b/source/About-builds.rst @@ -12,4 +12,34 @@ Sometimes you need to work with multiple packages together to build, share, and Summary ------- -ROS is a federated ecosystem and nearly every robotics system implemented in ROS makes use of multiple ROS packages. The build tools enable you to work with multiple packages in a single project - both packages of your own and those from the community. The build tools also enable you to share your own packages with the community. \ No newline at end of file +Most ROS systems use multiple packages working together. Build tools in ROS enable you to work with multiple packages in a single project and to share your packages with other members of the ROS community. + +Core ROS packages: + +* `colcon `_: Tool for creating and building a ROS workspace. + +* `ament_cmake `_: Build system for CMake-based packages in ROS. + +* `rosdoc2 `_: Tool for documenting a ROS package. QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. DO WE NEED TO INCLUDE ros2doc IN THIS LIST? + +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? + +Community-contributed packages: + +QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? + +Related content (placeholder) +--------------- + +More articles about builds: + +* Example + +* Example + +FAQs (placeholder) +---- + +* Example + +* Example \ No newline at end of file diff --git a/source/About-introspection.rst b/source/About-introspection.rst index 0e0197acf27..2798c735110 100644 --- a/source/About-introspection.rst +++ b/source/About-introspection.rst @@ -10,32 +10,32 @@ Sometimes you need to understand what is happening inside your robot's software. Summary ------- -Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand, and modify at run-time,node state, parameters, flowing data, and more. +Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand and modify, at run-time, node state, parameters, flowing data, and more. Core ROS packages: * `ros2doctor `_: Command line tool to check for common misconfigurations in a ROS system. -* `ros2launch `_: CLI tool for managing nodes. +* `ros2launch `_: Command line tool for launching multiple processes and for writing tests involving multiple processes. * `rosbag2 `_: Tool for recording and playing back data moving across topics, services and actions in a ROS application. -* `ros2cli `_: CLI tool for introspection. +* `ros2cli `_: A set of command line tools for ROS, used to manage nodes, topics, services, and other ROS components, including introspection. -* `RViz `_: Tool for visualization. +* `RViz `_: Provides a 3D visualization of the robot's perspective, including sensor data and intentions. * `rosdoc2 `_: Tool for documenting a ROS2 package. Community-contributed packages: -* `colcon `_: Tool for creating building a ROS 2 workspace. +* `colcon `_: Tool for creating and building a ROS workspace. -* `ament_cmake `_: Build system for CMake based packages in ROS 2. +* `ament_cmake `_: Build system for CMake-based packages in ROS. * `tracetools `_: Trace points for creating and debugging execution traces. -Related content +Related content (placeholder) --------------- More articles about introspection: @@ -44,7 +44,7 @@ More articles about introspection: * Example -FAQs +FAQs (placeholder) ---- * Example diff --git a/source/About-node-management.rst b/source/About-node-management.rst index 12abe847b47..3cc64743c90 100644 --- a/source/About-node-management.rst +++ b/source/About-node-management.rst @@ -11,4 +11,30 @@ Sometimes you need to manage many interconnected nodes at once to reliably start Summary ------- -Complex robotics systems typically involve many interconnected nodes each with multiple parameters and interfaces. Node management helps you automate start up, configuration, and shut down of a number of ROS nodes simultaneously, via launch files. \ No newline at end of file +Complex robotic systems can include many interconnected nodes, each with different settings and interfaces. Node management tools in ROS help you start, configure, and stop multiple nodes together using launch files. + +Core ROS packages: + +* `ros2launch `_: Command line tool for launching multiple processes and for writing tests involving multiple processes. + +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? + +Community-contributed packages: + +QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? + +Related content (placeholder) +--------------- + +More articles about node management: + +* Example + +* Example + +FAQs (placeholder) +---- + +* Example + +* Example \ No newline at end of file diff --git a/source/About-package-documentation.rst b/source/About-package-documentation.rst index 136261f3dcf..d2e259f358e 100644 --- a/source/About-package-documentation.rst +++ b/source/About-package-documentation.rst @@ -12,4 +12,30 @@ Sometimes you need to document your package so others can easily understand and Summary ------- -If you are creating a new package, it is good practice to document that package for others who may use it - whether the wider community or just within your own organization. The package documentation tools enable you to easily document your package and then build that documentation source into a web-browseable version, such as those seen on index.ros.org. \ No newline at end of file +When creating a new package, clear documentation is essential for others who may use it. Package documentation tools in ROS make it easy to write, maintain, and generate web-browsable documentation from your source code. + +Core ROS packages: + +* `rosdoc2 `_: Tool for documenting a ROS package. QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. DO WE NEED TO INCLUDE IN THIS LIST? + +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? + +Community-contributed packages: + +QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? + +Related content (placeholder) +--------------- + +More articles about package documentation: + +* Example + +* Example + +FAQs (placeholder) +---- + +* Example + +* Example \ No newline at end of file diff --git a/source/About-visualization.rst b/source/About-visualization.rst index d6096fd45b1..fb6d6850b57 100644 --- a/source/About-visualization.rst +++ b/source/About-visualization.rst @@ -12,4 +12,30 @@ Sometimes you need to visualize what your robot is sensing and planning to bette Summary ------- -It is much easier to develop, test, and debug a robotics system when you can understand what the robot is seeing, experiencing, and planning. Visualization tools transform the raw data from a robot into visual forms understandable by people. \ No newline at end of file +Understanding what a robot is sensing, experiencing, and planning makes development and debugging much easier. Visualization tools in ROS help you convert raw robot data into clear, human-readable visual formats. + +Core ROS packages: + +* `RViz `_: Provides a 3D visualization of the robot's perspective, including sensor data and intentions. + +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? + +Community-contributed packages: + +QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? + +Related content (placeholder) +--------------- + +More articles about visualization: + +* Example + +* Example + +FAQs (placeholder) +---- + +* Example + +* Example \ No newline at end of file From 3de9d3d10452e38e29cd49f9d562d47d4d96a7b3 Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Tue, 30 Jun 2026 14:11:33 +0000 Subject: [PATCH 06/10] adding content to tools articles --- source/About-analysis.rst | 16 +++---- source/About-builds.rst | 26 ++++++++--- source/About-introspection.rst | 24 ++++++---- source/About-node-management.rst | 19 ++++---- source/About-package-documentation.rst | 65 ++++++++++++++++++++++---- source/About-visualization.rst | 16 ++++--- source/index.rst | 2 +- 7 files changed, 120 insertions(+), 48 deletions(-) diff --git a/source/About-analysis.rst b/source/About-analysis.rst index 10934fe547c..5cf6dfadbc6 100644 --- a/source/About-analysis.rst +++ b/source/About-analysis.rst @@ -1,7 +1,8 @@ Analysis ======== -Sometimes you need tools to analyze the data from your robot to understand what it means. This article summarizes the ROS developer tools and guidance available to help with analysis. +Sometimes you need tools to analyze the data from your robot to understand what it means. +This article summarizes the ROS developer tools and guidance available to help with analysis. **Area: analysis, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -9,24 +10,23 @@ Sometimes you need tools to analyze the data from your robot to understand what :local: Summary -------- +------- -Capturing the data from your robot is just the first step. Analysis tools in ROS help you go further by making sense of that data and revealing insights at the right level of detail. +Capturing the data from your robot is just the first step. +Analysis tools in ROS help you go further by making sense of that data and revealing insights at the right level of detail. Core ROS packages: * `tracetools `_: Trace points for creating and debugging execution traces. - QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? Community-contributed packages: * `Plotjugler `_: Visualization and analysis tool for inspecting, monitoring, and interpreting time-series data. - QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? Related content (placeholder) ---------------- +----------------------------- More articles about analysis: @@ -35,8 +35,8 @@ More articles about analysis: * Example FAQs (placeholder) ----- +------------------ * Example -* Example \ No newline at end of file +* Example diff --git a/source/About-builds.rst b/source/About-builds.rst index 5a5be96c65f..f7206eb1fe6 100644 --- a/source/About-builds.rst +++ b/source/About-builds.rst @@ -1,7 +1,8 @@ Builds ====== -Sometimes you need to work with multiple packages together to build, share, and manage complex robotics systems efficiently. This article summarizes the ROS developer tools and guidance available to help with builds. +Sometimes you need to work with multiple packages together to build, share, and manage complex robotics systems efficiently. +This article summarizes the ROS developer tools and guidance available to help with builds. **Area: builds, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -12,7 +13,18 @@ Sometimes you need to work with multiple packages together to build, share, and Summary ------- -Most ROS systems use multiple packages working together. Build tools in ROS enable you to work with multiple packages in a single project and to share your packages with other members of the ROS community. +Most ROS systems use multiple packages working together. +Build tools in ROS enable you to work with multiple packages in a single project and to share your packages with other members of the ROS community. + +ROS build farm location +----------------------- + +The ROS build farm is critical infrastructure maintained by Open Robotics. +It supports the building of source and binary packages, as well as continuous integration, testing, and analysis for ROS packages: + +* ``_ + +Read more about ROS build farms: `ROS Build Farms — ROS 2 Documentation: Lyrical documentation `_ Core ROS packages: @@ -20,7 +32,9 @@ Core ROS packages: * `ament_cmake `_: Build system for CMake-based packages in ROS. -* `rosdoc2 `_: Tool for documenting a ROS package. QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. DO WE NEED TO INCLUDE ros2doc IN THIS LIST? +* `rosdoc2 `_: Tool for documenting a ROS package. +QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. +DO WE NEED TO INCLUDE ros2doc IN THIS LIST? QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? @@ -29,7 +43,7 @@ Community-contributed packages: QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? Related content (placeholder) ---------------- +----------------------------- More articles about builds: @@ -38,8 +52,8 @@ More articles about builds: * Example FAQs (placeholder) ----- +------------------ * Example -* Example \ No newline at end of file +* Example diff --git a/source/About-introspection.rst b/source/About-introspection.rst index 2798c735110..cc5dbb5bd89 100644 --- a/source/About-introspection.rst +++ b/source/About-introspection.rst @@ -1,7 +1,8 @@ Introspection ============= -Sometimes you need to understand what is happening inside your robot's software. This article summarizes the ROS developer tools and guidance available to help with introspection. +Sometimes you need to understand what is happening inside your robot's software. +This article summarizes the ROS developer tools and guidance available to help with introspection. **Area: introspection, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -9,8 +10,10 @@ Sometimes you need to understand what is happening inside your robot's software. :local: Summary -------- -Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand and modify, at run-time, node state, parameters, flowing data, and more. +------- + +Understanding what is happening inside your robot's software is key to understanding how to improve it. +Introspection tools in ROS allow you to understand and modify, at run-time, node state, parameters, flowing data, and more. Core ROS packages: @@ -18,11 +21,14 @@ Core ROS packages: * `ros2launch `_: Command line tool for launching multiple processes and for writing tests involving multiple processes. -* `rosbag2 `_: Tool for recording and playing back data moving across topics, services and actions in a ROS application. +* `rosbag2 `_: Tool for recording and playing back data moving across topics, services and actions in a ROS +application. -* `ros2cli `_: A set of command line tools for ROS, used to manage nodes, topics, services, and other ROS components, including introspection. +* `ros2cli `_: A set of command line tools for ROS, used to manage nodes, topics, services, and other ROS components, including +introspection. -* `RViz `_: Provides a 3D visualization of the robot's perspective, including sensor data and intentions. +* `RViz `_: Provides a 3D visualization of the robot's +perspective, including sensor data and intentions. * `rosdoc2 `_: Tool for documenting a ROS2 package. @@ -36,7 +42,7 @@ Community-contributed packages: * `tracetools `_: Trace points for creating and debugging execution traces. Related content (placeholder) ---------------- +----------------------------- More articles about introspection: @@ -45,8 +51,8 @@ More articles about introspection: * Example FAQs (placeholder) ----- +------------------ * Example -* Example \ No newline at end of file +* Example diff --git a/source/About-node-management.rst b/source/About-node-management.rst index 3cc64743c90..a90a3ce7747 100644 --- a/source/About-node-management.rst +++ b/source/About-node-management.rst @@ -1,7 +1,8 @@ Node management =============== -Sometimes you need to manage many interconnected nodes at once to reliably start, configure, and shut down your system. This article summarizes the ROS developer tools and guidance available to help with node management. +Sometimes you need to manage many interconnected nodes at once to reliably start, configure, and shut down your system. +This article summarizes the ROS developer tools and guidance available to help with node management. **Area: node management, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -10,21 +11,21 @@ Sometimes you need to manage many interconnected nodes at once to reliably start :local: Summary -------- -Complex robotic systems can include many interconnected nodes, each with different settings and interfaces. Node management tools in ROS help you start, configure, and stop multiple nodes together using launch files. +------- + +Complex robotic systems can include many interconnected nodes, each with different settings and interfaces. +Node management tools in ROS help you start, configure, and stop multiple nodes together using launch files. Core ROS packages: * `ros2launch `_: Command line tool for launching multiple processes and for writing tests involving multiple processes. - QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? -Community-contributed packages: - +Community-contributed packages: QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? Related content (placeholder) ---------------- +----------------------------- More articles about node management: @@ -33,8 +34,8 @@ More articles about node management: * Example FAQs (placeholder) ----- +------------------ * Example -* Example \ No newline at end of file +* Example diff --git a/source/About-package-documentation.rst b/source/About-package-documentation.rst index d2e259f358e..264b37b239a 100644 --- a/source/About-package-documentation.rst +++ b/source/About-package-documentation.rst @@ -1,8 +1,8 @@ Package documentation ===================== -Sometimes you need to document your package so others can easily understand and use it through a web-browseable format. This article summarizes the ROS developer tools and guidance available to help with package documentation. - +Sometimes you need to document your package so others can easily understand and use it through a web-browseable format. +This article summarizes the ROS developer tools and guidance available to help with package documentation. **Area: package documentation, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -10,13 +10,62 @@ Sometimes you need to document your package so others can easily understand and :local: Summary -------- +-------- + +When creating a new package, clear documentation is essential for others who may use it. +Package documentation tools in ROS make it easy to write, maintain, and generate web-browsable documentation from your source code. + +Package documentation locations +------------------------------- + +ROS package documentation can be found in multiple places. +Here is a brief list of where to look for specific ROS package documentation. + +* Most ROS packages have their package level documentation `included in this index page `_. + +* All ROS package documentation is hosted alongside its information on the `ROS Index `_. + + Searching for packages on ROS Index will yield their information such as released distributions, README.md files, URLs, and other important metadata. + +Larger packages +--------------- + +Larger packages like MoveIt, Nav2, and microROS, are given their own domain or subdomain on ros.org. +Here is a short list. + +* `MoveIt `_ + +* `Navigation2 `_ -When creating a new package, clear documentation is essential for others who may use it. Package documentation tools in ROS make it easy to write, maintain, and generate web-browsable documentation from your source code. +* `Control `_ + +* `microROS (embedded systems) `_ + +API documentation +----------------- + +You can find the API level documentation for the ROS client libraries in the Lyrical distribution using the links below: + +* `rclcpp - C++ client library `_ + +* `rclcpp_lifecycle - C++ lifecycle library `_ + +* `rclcpp_components - C++ components library `_ + +* `rclcpp_action - C++ actions library `_ + +Guidelines for adding your package documentation +------------------------------------------------ + +All released ROS packages are automatically added to docs.ros.org and `ROS Index `_. +If you would like to enable or configure your own package, see `Documenting a ROS package `_. Core ROS packages: -* `rosdoc2 `_: Tool for documenting a ROS package. QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. DO WE NEED TO INCLUDE IN THIS LIST? +* `rosdoc2 `_: Tool for documenting a ROS package. +QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. +DO WE NEED TO INCLUDE IN THIS LIST? QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? @@ -25,7 +74,7 @@ Community-contributed packages: QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? Related content (placeholder) ---------------- +----------------------------- More articles about package documentation: @@ -34,8 +83,8 @@ More articles about package documentation: * Example FAQs (placeholder) ----- +------------------ * Example -* Example \ No newline at end of file +* Example diff --git a/source/About-visualization.rst b/source/About-visualization.rst index fb6d6850b57..6bf51cbfa31 100644 --- a/source/About-visualization.rst +++ b/source/About-visualization.rst @@ -1,7 +1,8 @@ Visualization ============= -Sometimes you need to visualize what your robot is sensing and planning to better develop, test, and debug your system. This article summarizes the ROS developer tools and guidance available to help with visualization. +Sometimes you need to visualize what your robot is sensing and planning to better develop, test, and debug your system. +This article summarizes the ROS developer tools and guidance available to help with visualization. **Area: visualization, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -10,9 +11,10 @@ Sometimes you need to visualize what your robot is sensing and planning to bette :local: Summary -------- +------- -Understanding what a robot is sensing, experiencing, and planning makes development and debugging much easier. Visualization tools in ROS help you convert raw robot data into clear, human-readable visual formats. +Understanding what a robot is sensing, experiencing, and planning makes development and debugging much easier. +Visualization tools in ROS help you convert raw robot data into clear, human-readable visual formats. Core ROS packages: @@ -25,7 +27,7 @@ Community-contributed packages: QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? Related content (placeholder) ---------------- +----------------------------- More articles about visualization: @@ -33,9 +35,9 @@ More articles about visualization: * Example -FAQs (placeholder) ----- +FAQs (placeholder) +------------------ * Example -* Example \ No newline at end of file +* Example diff --git a/source/index.rst b/source/index.rst index 2a6aecfcef1..eb597aeb563 100644 --- a/source/index.rst +++ b/source/index.rst @@ -28,7 +28,7 @@ ROS 2 Documentation About-builds About-visualization About-package-documentation - + **The Robot Operating System (ROS) is a set of software libraries and tools for building robot applications.** From drivers and state-of-the-art algorithms to powerful developer tools, ROS has the open source tools you need for your next robotics project. From db0d361b22c95df6c7d73b2e71b7a2bc9916688e Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Mon, 13 Jul 2026 12:12:25 +0000 Subject: [PATCH 07/10] update introspection --- source/About-introspection.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/source/About-introspection.rst b/source/About-introspection.rst index cc5dbb5bd89..59f4b743f22 100644 --- a/source/About-introspection.rst +++ b/source/About-introspection.rst @@ -21,14 +21,11 @@ Core ROS packages: * `ros2launch `_: Command line tool for launching multiple processes and for writing tests involving multiple processes. -* `rosbag2 `_: Tool for recording and playing back data moving across topics, services and actions in a ROS -application. +* `rosbag2 `_: Tool for recording and playing back data moving across topics, services and actions in a ROS application. -* `ros2cli `_: A set of command line tools for ROS, used to manage nodes, topics, services, and other ROS components, including -introspection. +* `ros2cli `_: A set of command line tools for ROS, used to manage nodes, topics, services, and other ROS components, including introspection. -* `RViz `_: Provides a 3D visualization of the robot's -perspective, including sensor data and intentions. +* `RViz `_: Provides a 3D visualization of the robot's perspective, including sensor data and intentions. * `rosdoc2 `_: Tool for documenting a ROS2 package. From 8f3c9c37757c5ace6f021f18729f80566ff8c994 Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Mon, 13 Jul 2026 14:30:34 +0000 Subject: [PATCH 08/10] tools - peer review updates --- source/About-analysis.rst | 6 +-- source/About-builds.rst | 22 ++++----- source/About-introspection.rst | 14 +++--- source/About-node-management.rst | 1 + source/About-package-documentation.rst | 31 ++++++------ .../Concepts/Intermediate/About-Debugging.rst | 48 +++++++++++++++++++ 6 files changed, 85 insertions(+), 37 deletions(-) create mode 100644 source/Concepts/Intermediate/About-Debugging.rst diff --git a/source/About-analysis.rst b/source/About-analysis.rst index 5cf6dfadbc6..f0efc8dc3e3 100644 --- a/source/About-analysis.rst +++ b/source/About-analysis.rst @@ -1,7 +1,7 @@ Analysis ======== -Sometimes you need tools to analyze the data from your robot to understand what it means. +Analyzing introspection data can help with improving it's performance. This article summarizes the ROS developer tools and guidance available to help with analysis. **Area: analysis, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -12,7 +12,7 @@ This article summarizes the ROS developer tools and guidance available to help w Summary ------- -Capturing the data from your robot is just the first step. +Understanding what is happening inside your robot's software starts with introspection, which allows you to collect data. Analysis tools in ROS help you go further by making sense of that data and revealing insights at the right level of detail. Core ROS packages: @@ -22,7 +22,7 @@ QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIS Community-contributed packages: -* `Plotjugler `_: Visualization and analysis tool for inspecting, monitoring, and interpreting time-series data. +* `Plotjuggler `_: Visualization and analysis tool for inspecting, monitoring, and interpreting time-series data. QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? Related content (placeholder) diff --git a/source/About-builds.rst b/source/About-builds.rst index f7206eb1fe6..7069cb38890 100644 --- a/source/About-builds.rst +++ b/source/About-builds.rst @@ -1,7 +1,7 @@ Builds ====== -Sometimes you need to work with multiple packages together to build, share, and manage complex robotics systems efficiently. +The ability to work with multiple packages together is useful for developing complex robotics systems. This article summarizes the ROS developer tools and guidance available to help with builds. @@ -16,16 +16,6 @@ Summary Most ROS systems use multiple packages working together. Build tools in ROS enable you to work with multiple packages in a single project and to share your packages with other members of the ROS community. -ROS build farm location ------------------------ - -The ROS build farm is critical infrastructure maintained by Open Robotics. -It supports the building of source and binary packages, as well as continuous integration, testing, and analysis for ROS packages: - -* ``_ - -Read more about ROS build farms: `ROS Build Farms — ROS 2 Documentation: Lyrical documentation `_ - Core ROS packages: * `colcon `_: Tool for creating and building a ROS workspace. @@ -42,6 +32,16 @@ Community-contributed packages: QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? +ROS build farm location +----------------------- + +The ROS build farm is critical infrastructure maintained by Open Robotics. +It supports the building of source and binary packages, as well as continuous integration, testing, and analysis for ROS packages: + +* ``_ + +Read more about ROS build farms: `ROS Build Farms — ROS 2 Documentation: Lyrical documentation `_ + Related content (placeholder) ----------------------------- diff --git a/source/About-introspection.rst b/source/About-introspection.rst index 59f4b743f22..c5aeadd8c00 100644 --- a/source/About-introspection.rst +++ b/source/About-introspection.rst @@ -14,21 +14,19 @@ Summary Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand and modify, at run-time, node state, parameters, flowing data, and more. +ROS Analysis tools build further on this ability by enabling you to analyze the data gathered by introspection. + +See more at `About analysis `_. Core ROS packages: -* `ros2doctor `_: Command line tool to check for common misconfigurations in a ROS system. +* `ros2 `_: A set of software libraries and tools for building robot applications. -* `ros2launch `_: Command line tool for launching multiple processes and for writing tests involving multiple processes. +* `rqt `_: A set of graphical tools for visualizing and interacting with ROS data. * `rosbag2 `_: Tool for recording and playing back data moving across topics, services and actions in a ROS application. -* `ros2cli `_: A set of command line tools for ROS, used to manage nodes, topics, services, and other ROS components, including introspection. - -* `RViz `_: Provides a 3D visualization of the robot's perspective, including sensor data and intentions. - -* `rosdoc2 `_: Tool for documenting a ROS2 package. - +* `rosconsole `_: A logging tool for monitoring, debugging, and diagnosing running applications. Community-contributed packages: diff --git a/source/About-node-management.rst b/source/About-node-management.rst index a90a3ce7747..aa3ad9ce3b2 100644 --- a/source/About-node-management.rst +++ b/source/About-node-management.rst @@ -2,6 +2,7 @@ Node management =============== Sometimes you need to manage many interconnected nodes at once to reliably start, configure, and shut down your system. +Managing multiple interconnected nodes is essential for complex robotic systems. This article summarizes the ROS developer tools and guidance available to help with node management. diff --git a/source/About-package-documentation.rst b/source/About-package-documentation.rst index 264b37b239a..e4ee758d10e 100644 --- a/source/About-package-documentation.rst +++ b/source/About-package-documentation.rst @@ -1,8 +1,8 @@ Package documentation ===================== -Sometimes you need to document your package so others can easily understand and use it through a web-browseable format. -This article summarizes the ROS developer tools and guidance available to help with package documentation. +Package documentation is essential for others to understand and use the package you've developed. +This article summarizes the tools and guidance available to help with creating documentation for ROS packages. **Area: package documentation, tools | Content-type: about | Experience: beginner, intermediate, expert** @@ -15,6 +15,19 @@ Summary When creating a new package, clear documentation is essential for others who may use it. Package documentation tools in ROS make it easy to write, maintain, and generate web-browsable documentation from your source code. +Core ROS packages: + +* `rosdoc2 `_: Tool for documenting a ROS package. +QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. +DO WE NEED TO INCLUDE IN THIS LIST? + +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? + +Community-contributed packages: + +QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? + + Package documentation locations ------------------------------- @@ -25,7 +38,7 @@ Here is a brief list of where to look for specific ROS package documentation. * All ROS package documentation is hosted alongside its information on the `ROS Index `_. - Searching for packages on ROS Index will yield their information such as released distributions, README.md files, URLs, and other important metadata. +Searching for packages on ROS Index will yield their information such as released distributions, README.md files, URLs, and other important metadata. Larger packages --------------- @@ -61,18 +74,6 @@ All released ROS packages are automatically added to docs.ros.org and `ROS Index If you would like to enable or configure your own package, see `Documenting a ROS package `_. -Core ROS packages: - -* `rosdoc2 `_: Tool for documenting a ROS package. -QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. -DO WE NEED TO INCLUDE IN THIS LIST? - -QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? - -Community-contributed packages: - -QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? - Related content (placeholder) ----------------------------- diff --git a/source/Concepts/Intermediate/About-Debugging.rst b/source/Concepts/Intermediate/About-Debugging.rst new file mode 100644 index 00000000000..8f05945d843 --- /dev/null +++ b/source/Concepts/Intermediate/About-Debugging.rst @@ -0,0 +1,48 @@ +Debugging +========= + +Sometimes your robot won't behave as you expected. This article summarizes the ROS developer tools and guidance available to help with debugging. + +.. contents:: Table of Contents + :local: + +**Area: debugging, tools | Content-type: about | Experience: beginner, intermediate, expert** + +Summary +------- + +ROS provides a range of tools to help developers build, test, and monitor robotic systems. +Debugging is an essential part of development, and many of these tools can be used to identify and fix issues. +Some of the tools are also useful for other aspects of robotic system development. +For example, debugging overlaps with introspection, analysis, node management, visualization, and simulation, as these activities are often used to investigate and diagnose issues in a system. + +Core ROS packages: + +* `ros2doctor `_: Command line tool to check for common misconfigurations in a ROS system. + +* `tracetools `_: Trace points for creating and debugging execution traces. + +* `rosbag2 `_: Record and play back data moving across topics, services and actions in a ROS application, for later visualization and debugging. +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? + +Community-contributed packages: + +* `PlotJuggler `_: A tool for visualizing and analyzing data from ROS applications. +QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? + +Related content +--------------- + +More articles about debugging: + +.. + * `Debugging a ROS application - overview `_ + * `Using ros2doctor to identify issues - how-to `_ + * `Building ROS 2 with tracing - how-to `_ + +FAQs (placeholder) +------------------- + +* Example + +* Example From 9f29f29490f02c6f97721eee4a298e85212d386f Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Mon, 13 Jul 2026 14:43:44 +0000 Subject: [PATCH 09/10] update link to about analysis --- source/About-introspection.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/About-introspection.rst b/source/About-introspection.rst index c5aeadd8c00..9a52133e884 100644 --- a/source/About-introspection.rst +++ b/source/About-introspection.rst @@ -16,7 +16,7 @@ Understanding what is happening inside your robot's software is key to understan Introspection tools in ROS allow you to understand and modify, at run-time, node state, parameters, flowing data, and more. ROS Analysis tools build further on this ability by enabling you to analyze the data gathered by introspection. -See more at `About analysis `_. +See more at :doc:`About analysis ` Core ROS packages: From 287579f8d7204b4837421af620ca0a6b2e862bba Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Mon, 13 Jul 2026 15:39:07 +0000 Subject: [PATCH 10/10] tools - small update --- source/About-introspection.rst | 4 ++-- source/About-node-management.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/About-introspection.rst b/source/About-introspection.rst index 9a52133e884..8ecfa951711 100644 --- a/source/About-introspection.rst +++ b/source/About-introspection.rst @@ -14,9 +14,9 @@ Summary Understanding what is happening inside your robot's software is key to understanding how to improve it. Introspection tools in ROS allow you to understand and modify, at run-time, node state, parameters, flowing data, and more. -ROS Analysis tools build further on this ability by enabling you to analyze the data gathered by introspection. +ROS Analysis tools build further on this ability by enabling you to analyze the data gathered by introspection. -See more at :doc:`About analysis ` +See :doc:`About analysis ` Core ROS packages: diff --git a/source/About-node-management.rst b/source/About-node-management.rst index aa3ad9ce3b2..e0736516720 100644 --- a/source/About-node-management.rst +++ b/source/About-node-management.rst @@ -2,7 +2,7 @@ Node management =============== Sometimes you need to manage many interconnected nodes at once to reliably start, configure, and shut down your system. -Managing multiple interconnected nodes is essential for complex robotic systems. +Managing multiple interconnected nodes is essential for complex robotic systems. This article summarizes the ROS developer tools and guidance available to help with node management. @@ -22,7 +22,7 @@ Core ROS packages: * `ros2launch `_: Command line tool for launching multiple processes and for writing tests involving multiple processes. QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? -Community-contributed packages: +Community-contributed packages: QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? Related content (placeholder)