Skip to content

Commit

Permalink
docs: Organize software docs into different sections
Browse files Browse the repository at this point in the history
  • Loading branch information
cbrxyz committed Sep 10, 2024
1 parent dc3283b commit 8d0b85c
Showing 1 changed file with 67 additions and 10 deletions.
77 changes: 67 additions & 10 deletions docs/software/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,88 @@ Software
=====================
Various documentation related to practices followed by the MIL Software team.

Getting Started
---------------
Welcome to the software team, take a look at the following to get started!

.. toctree::
:maxdepth: 1

Getting Started <getting_started>
devtools
Contributing Changes <contributing>
documentation_syntax
adding_documentation
help
zobelisk


Technical Tools
---------------
Learn about some of the libraries and programs we use in MIL!

.. toctree::
:maxdepth: 1

asyncio
rqt
rostest
alarms
preflight
gazebo_guide
Developing with Submodules <submodule.md>


Best Practices
--------------
Read below for the best practices for our team!

.. toctree::
:maxdepth: 1

Bash Style Guide <bash_style.md>
C++ Style Guide <cpp_style.md>
Python Style Guide <python_style.md>
Gazebo Guide <gazebo_guide.md>
Migrating to ROS Noetic <noetic_migration.md>


MIL Tools
---------
Read about some of the tools used in MIL!

.. toctree::
:maxdepth: 1

documentation_syntax
adding_documentation
alarms
preflight


Hardware
--------
Check out some information about hardware used in MIL!

.. toctree::
:maxdepth: 1

calibrating_cams
Installing NVIDIA Drivers for RTX 2080 <rtx_2080_drivers.md>
Installing Ubuntu 18.04 on an M-series Apple computer <apple_mseries_ubuntu_setup.md>
zobelisk


Miscellaneous
-------------
We couldn't find a good spot for this stuff lol

.. toctree::
:maxdepth: 1

Resetting Ubuntu Administrative Password <resetubuntupass.md>
Network with Vehicles and Simulation Servers <../infrastructure/network.md>
calibrating_cams
Developing with Submodules <submodule.md>
Optional Extensions <extension_support.md>
Helpful Scripts <scripts>

Archived
--------
Below are documentation pages that are no longer used.

.. toctree::
:maxdepth: 1

Installing Ubuntu 18.04 on an M-series Apple computer <apple_mseries_ubuntu_setup.md>
Migrating to ROS Noetic <noetic_migration.md>

0 comments on commit 8d0b85c

Please sign in to comment.