Add more doc index pages (#54)

castacks · Sep 23, 2024 · 5e654ff · 5e654ff
1 parent 9bc6a44
commit 5e654ff
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 6 deletions.
diff --git a/docker/extras/drag_and_drop/.gitignore b/docker/extras/drag_and_drop/.gitignore
@@ -1,8 +1,9 @@
 AscentAeroSystemsSITLPackage/
 *~
+*.parm
 mav.parm
 mav.tlog
 mav.tlog.raw
 eeprom.bin
 logs
-terrain
+terrain
diff --git a/docs/ground_control_station/index.md b/docs/ground_control_station/index.md
@@ -1 +1,3 @@
+# Ground Control Station
+
 The Ground Control Station (GCS) is for operators to monitor and control the robots. 
diff --git a/docs/real_world/installation/index.md b/docs/real_world/installation/index.md
@@ -1 +1 @@
-# Installation
+# Installation on Hardware
diff --git a/docs/robot/autonomy/index.md b/docs/robot/autonomy/index.md
@@ -1,2 +1,3 @@
+# Robot Autonomy
 
 ![AirStack System Diagram](airstack_system_diagram.png)
diff --git a/docs/simulation/index.md b/docs/simulation/index.md
@@ -0,0 +1,3 @@
+# Simulation
+
+We primarily support Isaac Sim. In the future we plan to support Gazebo.
diff --git a/docs/simulation/isaac_sim/index.md b/docs/simulation/isaac_sim/index.md
@@ -0,0 +1 @@
+# Isaac Sim
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -3,9 +3,9 @@ copyright: Copyright &copy; 2024 - 2030 AirLab CMU
 extra:
   generator: false
   social:
-    - icon: fontawesome/brands/github 
+    - icon: fontawesome/brands/github
       link: https://github.com/castacks
-    - icon: fontawesome/brands/x-twitter 
+    - icon: fontawesome/brands/x-twitter
       link: https://x.com/airlabcmu
 extra_css:
   - stylesheets/extra.css
@@ -61,9 +61,11 @@ nav:
       - Multi-Robot:
           - ground_control_station/multi_robot/multi_robot.md
   - Simulation:
+      - simulation/index.md
       - Isaac Sim:
-          - simulation/isaac_sim/scene_setup.md
-          - simulation/isaac_sim/ascent_sitl_extension.md
+          - simulation/isaac_sim/index.md
+          - Scene Setup: simulation/isaac_sim/scene_setup.md
+          - Ascent SITL Extension: simulation/isaac_sim/ascent_sitl_extension.md
       - Gazebo:
           - simulation/gazebo/scene_setup.md
   - Real World:
@@ -82,10 +84,14 @@ theme:
     - navigation.indexes
     - navigation.path
     - navigation.tabs
+    - navigation.expand
     - navigation.footer
+    - navigation.top
+    - navigation.sections
     - search.highlight
     - search.suggest
     - toc.integrate
+    - toc.follow
     - content.code.copy
   logo: assets/logo_horizontal_white.png
   name: material
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# Ground Control Station

		The Ground Control Station (GCS) is for operators to monitor and control the robots.
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1,3 @@
		# Robot Autonomy

		![AirStack System Diagram](airstack_system_diagram.png)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Simulation

		We primarily support Isaac Sim. In the future we plan to support Gazebo.