Skip to content

Commit adc8d0f

Browse files
committed
Clean up TODOs in docs site (#48)
1 parent 2ced777 commit adc8d0f

16 files changed

+3
-92
lines changed

source/Getting-Started.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,8 @@
11
Getting Started
22
===============
33

4-
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.
5-
The following pages describe each of these scenarios.
4+
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 <Tutorials/First-Time-Building>`.
65

7-
.. toctree::
8-
:titlesonly:
9-
:maxdepth: 2
10-
11-
Getting-Started/Docker-Images
12-
Getting-Started/Building-From-Source
6+
Pre-built Docker images are available from the `OSRF Space ROS page <https://hub.docker.com/r/osrf/space-ros>`_ on Docker Hub.
137

148
Once you have a Docker image, you may want to review the :doc:`Demos <Demos>`, :doc:`Tutorials <Tutorials>`, and :doc:`How-To Guides <How-To-Guides>` to learn more about various Space ROS topics.
15-

source/Getting-Started/Building-From-Source.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

source/Getting-Started/Docker-Images.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

source/How-To-Guides.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,9 @@ They contain succinct steps to help you accomplish important tasks quickly.
99
.. toctree::
1010
:maxdepth: 1
1111

12-
How-To-Guides/Use-Custom-Allocator
1312
How-To-Guides/Reproducing-CI-Results
1413
How-To-Guides/Use-Cobra
1514
How-To-Guides/MC-DC-Testing-Tool
1615
How-To-Guides/Use-VSCode-With-Docker
1716
How-To-Guides/Use-The-Dashboard
18-
How-To-Guides/Use-Simulation-Assets
1917
How-To-Guides/Releasing-Space-ROS

source/How-To-Guides/Use-Custom-Allocator.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

source/How-To-Guides/Use-Simulation-Assets.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

source/Introduction.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ The following sections describe the motivation for Space ROS, how Space ROS is d
1717

1818
Introduction/About-Space-ROS
1919
Introduction/How-Space-ROS-Differs
20-
Introduction/Dev-And-Release-Model
2120

2221
.. image:: /images/viper-lights.png
2322
:alt: Artist's rendition of the VIPER rover on the surface of the moon
24-

source/Introduction/Dev-And-Release-Model.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

source/Related-Projects.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Related Projects
44
Space ROS makes use of several external projects that aren't part of standard ROS 2 distributions.
55
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.
66
The full set of code analysis tools are run automatically when building and running package tests ('colcon test').
7-
The next set of tools, Doorstop and FRET, are requirements tools that are part of an :doc:`overall requirements methodology <Tutorials/Requirements-Tools-And-Processes>` used for Space ROS.
7+
The next set of tools, Doorstop and FRET, are requirements tools used for Space ROS.
88
The last tool, Ogma, is a runtime verification tool that produces monitoring applications for Space ROS.
99

1010
.. toctree::

source/Related-Projects/Doorstop.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Why use Doorstop?
1515
Contributors to an open source project like Space ROS are unlikely to purchase expensive requirements management tools or use heavyweight requirements processes.
1616
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.
1717

18-
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.
19-
2018
Additional References
2119
---------------------
2220

@@ -25,4 +23,3 @@ Please refer to the following resources to learn more about Doorstop:
2523
* `Doorstop documentation <https://doorstop.readthedocs.io/en/latest/>`_
2624
* `The Doorstop github repository <https://github.com/doorstop-dev/doorstop>`_
2725
* `Doorstop: Text-Based Requirements Management Using Version Control <https://www.researchgate.net/publication/276044183_Doorstop_Text-Based_Requirements_Management_Using_Version_Control>`_
28-

0 commit comments

Comments
 (0)