From f0684e3b6235eb792009693b55e6f6b356440903 Mon Sep 17 00:00:00 2001 From: sarahfarnborough-3di Date: Thu, 20 Aug 2026 14:22:47 +0100 Subject: [PATCH] 3di | TOC update - align main toc titles with About ROS article (#7074) (cherry picked from commit d4643457b5bdbe76059d6d111edebc95f4e5e3b0) # Conflicts: # source/Concepts/Basic/About-Launch.rst # source/Developer-Tools.rst # source/Developer-Tools/About-Build.rst # source/How-To-Guides/Using-Custom-Rosdistro.rst # source/Integrations-and-related.rst # source/Migration-and-Upgrades.rst # source/ROS-Framework.rst # source/The-ROS2-Project.rst # source/index.rst --- source/Concepts/Basic/About-Launch.rst | 16 ++++++++++ source/Developer-Tools.rst | 16 ++++++++++ source/Developer-Tools/About-Build.rst | 31 +++++++++++++++++++ .../How-To-Guides/Using-Custom-Rosdistro.rst | 8 +++++ source/Integrations-and-related.rst | 13 ++++++++ source/Migration-and-Upgrades.rst | 12 +++++++ source/ROS-Framework.rst | 15 +++++++++ source/Related-Projects.rst | 2 +- source/The-ROS2-Project.rst | 5 +++ source/The-ROS2-Project/Adopters.rst | 2 +- source/The-ROS2-Project/Feature-Ideas.rst | 2 +- source/The-ROS2-Project/Features.rst | 2 +- source/The-ROS2-Project/Governance.rst | 2 +- .../The-ROS2-Project/Platform-EOL-Policy.rst | 2 +- .../Platform-Support-Tiers.rst | 2 +- source/The-ROS2-Project/ROSCon-Content.rst | 2 +- source/The-ROS2-Project/Release-Schedule.rst | 2 +- source/index.rst | 10 ++++++ 18 files changed, 135 insertions(+), 9 deletions(-) create mode 100644 source/Developer-Tools.rst create mode 100644 source/Developer-Tools/About-Build.rst create mode 100644 source/Integrations-and-related.rst create mode 100644 source/Migration-and-Upgrades.rst create mode 100644 source/ROS-Framework.rst diff --git a/source/Concepts/Basic/About-Launch.rst b/source/Concepts/Basic/About-Launch.rst index d205b11c462..f537e23bd95 100644 --- a/source/Concepts/Basic/About-Launch.rst +++ b/source/Concepts/Basic/About-Launch.rst @@ -1,5 +1,21 @@ +<<<<<<< HEAD:source/Concepts/Basic/About-Launch.rst Launch ====== +======= +.. redirect-from:: + + Concepts/Basic/About-Launch + +Node management +=============== +.. toctree:: + :maxdepth: 1 + :hidden: + + Launch/Launch-Main + Launch/Launching-composable-nodes + Launch/Launch-file-different-formats +>>>>>>> d464345 (3di | TOC update - align main toc titles with About ROS article (#7074)):source/Developer-Tools/About-Launch.rst .. contents:: Table of Contents :local: diff --git a/source/Developer-Tools.rst b/source/Developer-Tools.rst new file mode 100644 index 00000000000..d56f2d068a5 --- /dev/null +++ b/source/Developer-Tools.rst @@ -0,0 +1,16 @@ +Tools +===== + + +Coming Soon + +.. toctree:: + :maxdepth: 3 + + Developer-Tools/About-introspection-and-analysis + Developer-Tools/About-Launch + Developer-Tools/About-Debugging + Developer-Tools/About-Build + Developer-Tools/About-visualization + Developer-Tools/About-package-documentation + Developer-Tools/About-testing diff --git a/source/Developer-Tools/About-Build.rst b/source/Developer-Tools/About-Build.rst new file mode 100644 index 00000000000..07bde6565e2 --- /dev/null +++ b/source/Developer-Tools/About-Build.rst @@ -0,0 +1,31 @@ +Builds +======== + +Coming Soon + +.. toctree:: + :maxdepth: 3 + + Build/About-Cross-Compilation + Build/About-Build-System + Build/Deployment-Guidelines/Deployment-Guidelines + Build/The-Keystore + Build/Using-Xacro-to-Clean-Up-a-URDF-File/Using-Xacro-to-Clean-Up-a-URDF-File + Build/Supplementing-Custom-Rosdep-Keys + Build/Ament-Lint-For-Clean-Code + Build/Eclipse-Oxygen-with-ROS-2-and-rviz2/Eclipse-Oxygen-with-ROS-2-and-rviz2 + Build/Ament-CMake-Documentation + Build/Ament-CMake-Python-Documentation + Build/Building-a-Custom-Deb-Package + Build/Run-2-nodes-in-single-or-separate-docker-containers + Build/Setup-ROS-2-with-VSCode-and-Docker-Container + Build/Core-maintainer-guide + Build/DDS-tuning + Build/Using-Variants + Build/Package-Docs + Build/Using-Python-Packages + Build/Developing-a-ROS-2-Package + Build/Releasing/Releasing-a-Package + Build/Building-Realtime-rt_preempt-kernel-for-ROS-2/Building-Realtime-rt_preempt-kernel-for-ROS-2 + Build/Building-ROS2-Package-with-eclipse-2021-06/Building-ROS2-Package-with-eclipse-2021-06 + Build/Single-Package-Define-And-Use-Interface diff --git a/source/How-To-Guides/Using-Custom-Rosdistro.rst b/source/How-To-Guides/Using-Custom-Rosdistro.rst index 575ca1b04d4..f59a59ed925 100644 --- a/source/How-To-Guides/Using-Custom-Rosdistro.rst +++ b/source/How-To-Guides/Using-Custom-Rosdistro.rst @@ -1,4 +1,12 @@ +<<<<<<< HEAD:source/How-To-Guides/Using-Custom-Rosdistro.rst Using Custom Rosdistro Version +======= +.. redirect-from:: + + How-To-Guides/Using-Custom-Rosdistro + +Using custom rosdistro version +>>>>>>> d464345 (3di | TOC update - align main toc titles with About ROS article (#7074)):source/Migration-and-Upgrades/Using-Custom-Rosdistro.rst ============================== diff --git a/source/Integrations-and-related.rst b/source/Integrations-and-related.rst new file mode 100644 index 00000000000..060dc50a7c7 --- /dev/null +++ b/source/Integrations-and-related.rst @@ -0,0 +1,13 @@ + +Integrations +============ + +Coming Soon + +.. toctree:: + :hidden: + :glob: + + Integrations-and-related/Simulators/Simulation-Main + Integrations-and-related/Deploying-ROS-2-on-IBM-Cloud + Integrations-and-related/Related-Projects diff --git a/source/Migration-and-Upgrades.rst b/source/Migration-and-Upgrades.rst new file mode 100644 index 00000000000..5b8085e6406 --- /dev/null +++ b/source/Migration-and-Upgrades.rst @@ -0,0 +1,12 @@ +Migration and upgrades +====================== + +Coming Soon + +.. toctree:: + :hidden: + :glob: + + Migration-and-Upgrades/Migrating-from-ROS1 + Migration-and-Upgrades/Using-ros1_bridge-Jammy-upstream + Migration-and-Upgrades/Using-Custom-Rosdistro diff --git a/source/ROS-Framework.rst b/source/ROS-Framework.rst new file mode 100644 index 00000000000..c5c22570e9b --- /dev/null +++ b/source/ROS-Framework.rst @@ -0,0 +1,15 @@ + + +Framework +========= + +Coming Soon + +.. toctree:: + :maxdepth: 3 + + ROS-Framework/How-ROS-Works + ROS-Framework/About-Nodes + ROS-Framework/Interfaces-Topics-Services-Actions + ROS-Framework/About-Parameters + ROS-Framework/About-Client-Libraries diff --git a/source/Related-Projects.rst b/source/Related-Projects.rst index 6090a2a8b15..88a3828f8f0 100644 --- a/source/Related-Projects.rst +++ b/source/Related-Projects.rst @@ -1,5 +1,5 @@ -Related Projects +Related projects ================ Gazebo diff --git a/source/The-ROS2-Project.rst b/source/The-ROS2-Project.rst index 9a7aafc1050..bb1a928b724 100644 --- a/source/The-ROS2-Project.rst +++ b/source/The-ROS2-Project.rst @@ -1,5 +1,10 @@ +<<<<<<< HEAD The ROS 2 Project ================= +======= +Community +========= +>>>>>>> d464345 (3di | TOC update - align main toc titles with About ROS article (#7074)) Check out the resources below to learn more about the advancement of the ROS 2 project. diff --git a/source/The-ROS2-Project/Adopters.rst b/source/The-ROS2-Project/Adopters.rst index 6e046ff3e53..53acd4d94dd 100644 --- a/source/The-ROS2-Project/Adopters.rst +++ b/source/The-ROS2-Project/Adopters.rst @@ -2,7 +2,7 @@ The-ROS2-Project/Adopters/Adopters -ROS 2 Adopters +ROS 2 adopters ============== This page showcases organizations and projects using ROS in any capacity. diff --git a/source/The-ROS2-Project/Feature-Ideas.rst b/source/The-ROS2-Project/Feature-Ideas.rst index c1aa0acdf9a..90f9b2c8d62 100644 --- a/source/The-ROS2-Project/Feature-Ideas.rst +++ b/source/The-ROS2-Project/Feature-Ideas.rst @@ -4,7 +4,7 @@ .. _FeatureIdeas: -Feature Ideas +Feature ideas ============= .. contents:: Table of Contents diff --git a/source/The-ROS2-Project/Features.rst b/source/The-ROS2-Project/Features.rst index c5fa8489a01..bf7df4ebb93 100644 --- a/source/The-ROS2-Project/Features.rst +++ b/source/The-ROS2-Project/Features.rst @@ -4,7 +4,7 @@ .. _Features: -Features Status +Features status =============== The features listed below are available in the current ROS 2 release. diff --git a/source/The-ROS2-Project/Governance.rst b/source/The-ROS2-Project/Governance.rst index fd4f8c0d659..c87d35a22cb 100644 --- a/source/The-ROS2-Project/Governance.rst +++ b/source/The-ROS2-Project/Governance.rst @@ -4,7 +4,7 @@ .. _Governance: -Project Governance +Project governance ================== .. contents:: Table of Contents diff --git a/source/The-ROS2-Project/Platform-EOL-Policy.rst b/source/The-ROS2-Project/Platform-EOL-Policy.rst index 28dfaffb8ea..afb880183d7 100644 --- a/source/The-ROS2-Project/Platform-EOL-Policy.rst +++ b/source/The-ROS2-Project/Platform-EOL-Policy.rst @@ -1,6 +1,6 @@ .. _PlatformEOLPolicy: -Platform EOL Policy +Platform EOL policy =================== .. contents:: Table of Contents diff --git a/source/The-ROS2-Project/Platform-Support-Tiers.rst b/source/The-ROS2-Project/Platform-Support-Tiers.rst index b35e972f89c..2ad4daac861 100644 --- a/source/The-ROS2-Project/Platform-Support-Tiers.rst +++ b/source/The-ROS2-Project/Platform-Support-Tiers.rst @@ -1,4 +1,4 @@ -Platform Support Tiers +Platform support tiers ====================== Platforms are defined as a combination of the OS, the architecture, and the RMW implementation. diff --git a/source/The-ROS2-Project/ROSCon-Content.rst b/source/The-ROS2-Project/ROSCon-Content.rst index ddb570e4f98..9b1e3f9991f 100644 --- a/source/The-ROS2-Project/ROSCon-Content.rst +++ b/source/The-ROS2-Project/ROSCon-Content.rst @@ -4,7 +4,7 @@ .. _ROSCon: -ROSCon Talks +ROSCon talks ============ The following `ROSCon `__ talks have been given on ROS 2 and provide information about the workings of ROS 2 and various demos: diff --git a/source/The-ROS2-Project/Release-Schedule.rst b/source/The-ROS2-Project/Release-Schedule.rst index 3dfdc9cbada..b5056c710d4 100644 --- a/source/The-ROS2-Project/Release-Schedule.rst +++ b/source/The-ROS2-Project/Release-Schedule.rst @@ -1,4 +1,4 @@ -Release Schedule +Release schedule ================ Frequency diff --git a/source/index.rst b/source/index.rst index 94f6661eb4a..6e4e03c4805 100644 --- a/source/index.rst +++ b/source/index.rst @@ -10,12 +10,22 @@ ROS 2 Documentation :maxdepth: 1 :hidden: +<<<<<<< HEAD About-ROS Installation Releases Tutorials How-To-Guides Concepts +======= + Get-Started + ROS-Framework + Developer-Tools + Capabilities + Integrations-and-related + Migration-and-Upgrades + The-ROS2-Project +>>>>>>> d464345 (3di | TOC update - align main toc titles with About ROS article (#7074)) Contact The-ROS2-Project Package-Docs