diff --git a/docs/software/index.rst b/docs/software/index.rst index 299168e7c..266ff402b 100644 --- a/docs/software/index.rst +++ b/docs/software/index.rst @@ -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 devtools Contributing Changes - 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 + + +Best Practices +-------------- +Read below for the best practices for our team! + +.. toctree:: + :maxdepth: 1 + Bash Style Guide C++ Style Guide Python Style Guide - Gazebo Guide - Migrating to ROS Noetic + + +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 - Installing Ubuntu 18.04 on an M-series Apple computer + zobelisk + + +Miscellaneous +------------- +We couldn't find a good spot for this stuff lol + +.. toctree:: + :maxdepth: 1 + Resetting Ubuntu Administrative Password Network with Vehicles and Simulation Servers <../infrastructure/network.md> - calibrating_cams - Developing with Submodules Optional Extensions Helpful Scripts + +Archived +-------- +Below are documentation pages that are no longer used. + +.. toctree:: + :maxdepth: 1 + + Installing Ubuntu 18.04 on an M-series Apple computer + Migrating to ROS Noetic