Add more to docs

castacks · Jul 2, 2024 · 559fdf3 · 559fdf3
1 parent a78878a
commit 559fdf3
Show file tree

Hide file tree

Showing 17 changed files with 80 additions and 30 deletions.
diff --git a/docs/about.md b/docs/about.md
@@ -1 +1,3 @@
-# About
+# About
+
+The stack is maintained by Andrew Jong and John Keller.
diff --git a/docs/assets/StackedWhite.png b/docs/assets/StackedWhite.png
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/logo_horizontal_white.png b/docs/assets/logo_horizontal_white.png
diff --git a/docs/assets/red_white.ico b/docs/assets/red_white.ico
diff --git a/docs/developer_guide/autonomy/controls.md b/docs/developer_guide/autonomy/controls.md
@@ -0,0 +1,11 @@
+# Controls
+Code located in `AirLab-Autonomy-Stack/ros_ws/src/robot/autonomy/controls/`.
+
+
+## Robot Interface class
+The `RobotInterface` translates commands from the autonomy stack into the command for the underlying hardware.
+Specific implementations should extend `class RobotInterface` in `robot_interface.hpp`
+
+Commands: Attitude control and Position control.
+
+These are reflected in both PX4 and Ardupilot. 
diff --git a/docs/modules/navigation.md → docs/developer_guide/autonomy/mapping.md b/docs/modules/navigation.md → docs/developer_guide/autonomy/mapping.md
diff --git a/docs/modules/perception.md → docs/developer_guide/autonomy/navigation.md b/docs/modules/perception.md → docs/developer_guide/autonomy/navigation.md
diff --git a/docs/modules/planning.md → docs/developer_guide/autonomy/perception.md b/docs/modules/planning.md → docs/developer_guide/autonomy/perception.md
diff --git a/docs/modules/simulation.md → docs/developer_guide/autonomy/planning.md b/docs/modules/simulation.md → docs/developer_guide/autonomy/planning.md
diff --git a/docs/developer_guide/contributing.md b/docs/developer_guide/contributing.md
@@ -0,0 +1,30 @@
+# Contributing
+This page describes how to merge content back into main.
+
+
+## Documentation
+Please make sure to document your work.
+Docs are under `AirLab-Autonomy-Stack/docs/`
+
+This documentation is built with Material MKDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
+
+### Commands
+```
+pip install mkdocs-material
+mkdocs serve
+```
+
+* `mkdocs -h` - Print help message and exit.
+
+### Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
+
+## Merge
+Submit a pull request.
diff --git a/docs/developer_guide/dev_guide.md b/docs/developer_guide/dev_guide.md
@@ -0,0 +1,4 @@
+# Developer Guide
+
+Welcome researchers! This guide documents how to extend the autonomy stack for your own needs.
+The stack has been designed with modularity in mind, and aims to make it straight forward to swap out any component.
diff --git a/docs/developer_guide/documentation.md b/docs/developer_guide/documentation.md
diff --git a/docs/developer_guide/simulation.md b/docs/developer_guide/simulation.md
@@ -0,0 +1,13 @@
+# Simulation
+
+Code located in `AirLab-Autonomy-Stack/simulation/`
+
+
+## Types of Simulation
+
+### Simulation Engine
+For graphics and dynamics
+
+### Software/Hardware in the Loop
+For drone dynamics
+
diff --git a/docs/index.md b/docs/index.md
@@ -1,18 +1,5 @@
 # Welcome to the AirLab Autonomy Stack
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+This documentation is for the AirLab Autonomy Stack.
 
+It is maintained by the [AirLab](https://theairlab.org) at Carnegie Mellon University's Robotics Institute.
diff --git a/docs/modules/controls.md b/docs/modules/controls.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,8 @@
 site_name: "AirLab Autonomy Stack"
 theme:
   name: material
+  logo: assets/logo_horizontal_white.png
+  favicon: assets/StackedWhite.png
   palette: 
     - scheme: default
       primary: "#CC002B"
@@ -33,15 +35,23 @@ plugins:
 
 nav:
   - "Home": 'index.md'
-  - "About": 'about.md'
   - "User Guide":
-    - "Installation": "user_guide/installation.md"
     - "Getting Started": "user_guide/getting_started.md"
+    - "Installation": "user_guide/installation.md"
     - "Tutorials": "user_guide/tutorials.md"
     - "API Reference": "user_guide/api_reference.md"
-  - "Modules":
-    - "Controls": "modules/controls.md"
-    - "Perception": "modules/perception.md"
-    - "Planning": "modules/planning/planning.md"
-    - "Simulation": "modules/simulation.md"
+  - "Developer Guide": 
+    - "Developer Home": "developer_guide/dev_guide.md"
+    - "Autonomy":
+      - "Perception": "developer_guide/autonomy/perception.md"
+      - "Mapping": "developer_guide/autonomy/mapping.md"
+      - "Planning": "developer_guide/autonomy/planning.md"
+      - "Navigation": "developer_guide/autonomy/navigation.md"
+      - "Controls": "developer_guide/autonomy/controls.md"
+    - "Simulation": "developer_guide/simulation.md"
+    - "Contributing": "developer_guide/contributing.md"
+  - "About": 'about.md'
+
+repo_url: https://github.com/castacks/AirLab-Autonomy-Stack
+repo_name: castacks/AirLab-Autonomy-Stack