From adc8d0f52e9074de6b3a8844b94d1ba74fd77476 Mon Sep 17 00:00:00 2001 From: Ezra Brooks Date: Wed, 8 Oct 2025 09:56:32 -0600 Subject: [PATCH] Clean up TODOs in docs site (#48) --- source/Getting-Started.rst | 11 ++--------- source/Getting-Started/Building-From-Source.rst | 6 ------ source/Getting-Started/Docker-Images.rst | 9 --------- source/How-To-Guides.rst | 2 -- source/How-To-Guides/Use-Custom-Allocator.rst | 8 -------- source/How-To-Guides/Use-Simulation-Assets.rst | 7 ------- source/Introduction.rst | 2 -- source/Introduction/Dev-And-Release-Model.rst | 11 ----------- source/Related-Projects.rst | 2 +- source/Related-Projects/Doorstop.rst | 3 --- source/Related-Projects/FRET.rst | 2 -- source/Tutorials.rst | 4 ---- source/Tutorials/Back-Porting-Requirements.rst | 6 ------ source/Tutorials/Eventing-And-Telemetry.rst | 6 ------ source/Tutorials/Requirements-Tools-And-Processes.rst | 8 -------- source/Tutorials/Run-On-RTEMS.rst | 8 -------- 16 files changed, 3 insertions(+), 92 deletions(-) delete mode 100644 source/Getting-Started/Building-From-Source.rst delete mode 100644 source/Getting-Started/Docker-Images.rst delete mode 100644 source/How-To-Guides/Use-Custom-Allocator.rst delete mode 100644 source/How-To-Guides/Use-Simulation-Assets.rst delete mode 100644 source/Introduction/Dev-And-Release-Model.rst delete mode 100644 source/Tutorials/Back-Porting-Requirements.rst delete mode 100644 source/Tutorials/Eventing-And-Telemetry.rst delete mode 100644 source/Tutorials/Requirements-Tools-And-Processes.rst delete mode 100644 source/Tutorials/Run-On-RTEMS.rst diff --git a/source/Getting-Started.rst b/source/Getting-Started.rst index 60352ae..7251a25 100644 --- a/source/Getting-Started.rst +++ b/source/Getting-Started.rst @@ -1,15 +1,8 @@ Getting Started =============== -To get started with Space ROS development, you can either download a pre-built Docker image from Docker Hub, or build the Docker image yourself. -The following pages describe each of these scenarios. +To get started with Space ROS development, you can either download a pre-built Docker image from Docker Hub, or build the Docker image yourself using the instructions in the :doc:`First Time Building tutorial `. -.. toctree:: - :titlesonly: - :maxdepth: 2 - - Getting-Started/Docker-Images - Getting-Started/Building-From-Source +Pre-built Docker images are available from the `OSRF Space ROS page `_ on Docker Hub. Once you have a Docker image, you may want to review the :doc:`Demos `, :doc:`Tutorials `, and :doc:`How-To Guides ` to learn more about various Space ROS topics. - diff --git a/source/Getting-Started/Building-From-Source.rst b/source/Getting-Started/Building-From-Source.rst deleted file mode 100644 index 6c17b58..0000000 --- a/source/Getting-Started/Building-From-Source.rst +++ /dev/null @@ -1,6 +0,0 @@ -Building Space ROS from Source -============================== - -TODO: - -Describe how to build Space ROS from source code (presumably using Earthly). diff --git a/source/Getting-Started/Docker-Images.rst b/source/Getting-Started/Docker-Images.rst deleted file mode 100644 index e1822e1..0000000 --- a/source/Getting-Started/Docker-Images.rst +++ /dev/null @@ -1,9 +0,0 @@ -The Space ROS Docker Images -=========================== - -TODO: - -Describe how to use the Space ROS docker image from Docker Hub, and any other images published to Docker Hub. - -* Docker Hub -* Base image, MoveIt2, demos, etc. diff --git a/source/How-To-Guides.rst b/source/How-To-Guides.rst index 597059c..718f8e1 100644 --- a/source/How-To-Guides.rst +++ b/source/How-To-Guides.rst @@ -9,11 +9,9 @@ They contain succinct steps to help you accomplish important tasks quickly. .. toctree:: :maxdepth: 1 - How-To-Guides/Use-Custom-Allocator How-To-Guides/Reproducing-CI-Results How-To-Guides/Use-Cobra How-To-Guides/MC-DC-Testing-Tool How-To-Guides/Use-VSCode-With-Docker How-To-Guides/Use-The-Dashboard - How-To-Guides/Use-Simulation-Assets How-To-Guides/Releasing-Space-ROS diff --git a/source/How-To-Guides/Use-Custom-Allocator.rst b/source/How-To-Guides/Use-Custom-Allocator.rst deleted file mode 100644 index d0fd888..0000000 --- a/source/How-To-Guides/Use-Custom-Allocator.rst +++ /dev/null @@ -1,8 +0,0 @@ -Using a Custom Memory Allocator with Space ROS -============================================== - -TODO: - -* How to use a custom memory allocator with Space ROS. -* How to use the memory_tools package to confirm that no additional memory is allocated via other means beyond the supplied allocator. - diff --git a/source/How-To-Guides/Use-Simulation-Assets.rst b/source/How-To-Guides/Use-Simulation-Assets.rst deleted file mode 100644 index d9a207f..0000000 --- a/source/How-To-Guides/Use-Simulation-Assets.rst +++ /dev/null @@ -1,7 +0,0 @@ -Using Space-Related Simulation Assets -===================================== - -TODO: - -How to use the provided simulation assets in a new project. - diff --git a/source/Introduction.rst b/source/Introduction.rst index 4a589bc..c44239e 100644 --- a/source/Introduction.rst +++ b/source/Introduction.rst @@ -17,8 +17,6 @@ The following sections describe the motivation for Space ROS, how Space ROS is d Introduction/About-Space-ROS Introduction/How-Space-ROS-Differs - Introduction/Dev-And-Release-Model .. image:: /images/viper-lights.png :alt: Artist's rendition of the VIPER rover on the surface of the moon - diff --git a/source/Introduction/Dev-And-Release-Model.rst b/source/Introduction/Dev-And-Release-Model.rst deleted file mode 100644 index a285e43..0000000 --- a/source/Introduction/Dev-And-Release-Model.rst +++ /dev/null @@ -1,11 +0,0 @@ -The Space ROS Development and Release Model -=========================================== - -TODO: - -Describe the development and release model for Space ROS. For example, - -* How we target Humble’s release track -* How contributions are made to Space ROS -* When to target upstream -* Handling changes unique to Space ROS diff --git a/source/Related-Projects.rst b/source/Related-Projects.rst index 5f83b59..2d00961 100644 --- a/source/Related-Projects.rst +++ b/source/Related-Projects.rst @@ -4,7 +4,7 @@ Related Projects Space ROS makes use of several external projects that aren't part of standard ROS 2 distributions. The first pair of tools, IKOS and Cobra, are static analysis tools that have been integrated into Space ROS using the same Python wrapper method used for other code analysis tools integrated into standard ROS 2 distributions, such as clang-tidy and cpplint. The full set of code analysis tools are run automatically when building and running package tests ('colcon test'). -The next set of tools, Doorstop and FRET, are requirements tools that are part of an :doc:`overall requirements methodology ` used for Space ROS. +The next set of tools, Doorstop and FRET, are requirements tools used for Space ROS. The last tool, Ogma, is a runtime verification tool that produces monitoring applications for Space ROS. .. toctree:: diff --git a/source/Related-Projects/Doorstop.rst b/source/Related-Projects/Doorstop.rst index 32fc2b4..0dde21a 100644 --- a/source/Related-Projects/Doorstop.rst +++ b/source/Related-Projects/Doorstop.rst @@ -15,8 +15,6 @@ Why use Doorstop? Contributors to an open source project like Space ROS are unlikely to purchase expensive requirements management tools or use heavyweight requirements processes. Using the open source Doorstop tool to manage requirements helps to strike a balance between the need for strong processes to support certification, such as requirements traceability, and ease-of-contributing for the open source community. -To learn more about how Doorstop is used in Space ROS, please refer to this tutorial on the `Requirements Tools and Processes <../Tutorials/Requirements-Tools-And-Processes>`_ used in Space ROS. - Additional References --------------------- @@ -25,4 +23,3 @@ Please refer to the following resources to learn more about Doorstop: * `Doorstop documentation `_ * `The Doorstop github repository `_ * `Doorstop: Text-Based Requirements Management Using Version Control `_ - diff --git a/source/Related-Projects/FRET.rst b/source/Related-Projects/FRET.rst index e979ef9..a6533d1 100644 --- a/source/Related-Projects/FRET.rst +++ b/source/Related-Projects/FRET.rst @@ -29,8 +29,6 @@ Doorstop, along with git, is used to ensure requirements tracking and traceabili To facilitate interoperability, FRET is able to import and export the Markdown-based requirements file format used by Doorstop. Requirements can be stored in a git repository and operated on by either FRET or Doorstop. -To learn more about how FRET is used in Space ROS, please refer to this tutorial on the `Requirements Tools and Processes <../Tutorials/Requirements-Tools-And-Processes>`_ used in Space ROS. - Additional References --------------------- diff --git a/source/Tutorials.rst b/source/Tutorials.rst index fc5afa0..53294e0 100644 --- a/source/Tutorials.rst +++ b/source/Tutorials.rst @@ -11,7 +11,3 @@ The following tutorials are specific to Space ROS. :maxdepth: 2 Tutorials/First-Time-Building - Tutorials/Eventing-And-Telemetry - Tutorials/Requirements-Tools-And-Processes - Tutorials/Back-Porting-Requirements - Tutorials/Run-On-RTEMS diff --git a/source/Tutorials/Back-Porting-Requirements.rst b/source/Tutorials/Back-Porting-Requirements.rst deleted file mode 100644 index cd57922..0000000 --- a/source/Tutorials/Back-Porting-Requirements.rst +++ /dev/null @@ -1,6 +0,0 @@ -Back-Porting Requirements -========================= - -TODO: - -Describe how requirements were back-ported for rcutils diff --git a/source/Tutorials/Eventing-And-Telemetry.rst b/source/Tutorials/Eventing-And-Telemetry.rst deleted file mode 100644 index 0a9e44f..0000000 --- a/source/Tutorials/Eventing-And-Telemetry.rst +++ /dev/null @@ -1,6 +0,0 @@ -The Eventing and Telemetry Subsystem -==================================== - -TODO: - -Describe the Space ROS Eventing and Telemetry Subsystem. diff --git a/source/Tutorials/Requirements-Tools-And-Processes.rst b/source/Tutorials/Requirements-Tools-And-Processes.rst deleted file mode 100644 index b9de8cf..0000000 --- a/source/Tutorials/Requirements-Tools-And-Processes.rst +++ /dev/null @@ -1,8 +0,0 @@ -Requirements Tools and Processes -================================ - -TODO: - -* Describe the overall vision -* Walk through how to use Doorstop and FRET -* Describe our existing examples of using Doorstop (and FRET) diff --git a/source/Tutorials/Run-On-RTEMS.rst b/source/Tutorials/Run-On-RTEMS.rst deleted file mode 100644 index 6ef782e..0000000 --- a/source/Tutorials/Run-On-RTEMS.rst +++ /dev/null @@ -1,8 +0,0 @@ -Running Space ROS on RTEMS -========================== - -TODO: - -* Provide some background on RTEMS -* Describe how to run Space ROS on RTEMS -