Merge pull request #129 from StarlingUAS/pr-docs-tutorials

Fenswood Tutorial Documentation
StarlingUAS · Dec 17, 2021 · ea60a28 · ea60a28
2 parents 8f3ab71 + 7795210
commit ea60a28
Show file tree

Hide file tree

Showing 15 changed files with 780 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -43,11 +43,11 @@ By virtue of the architecture, the system also includes failure recovery and det
 ## Contact
 The initial developers of this project are:
 
-- Mickey Li - [email](mailto:[email protected]) - [github](github.com/mhl787156)
-- Robert Clarke - [email](mailto:[email protected]) - [github](github.com/rob-clarke)
+- Mickey Li - [email](mailto:[email protected]) - [github](https://github.com/mhl787156)
+- Robert Clarke - [email](mailto:[email protected]) - [github](https://github.com/rob-clarke)
 
 ## FAQs
-Please see documentation, or raise an [Issue on the github repo](github.com/UoBFlightLab/ProjectStarling/issues)
+Please see documentation, or raise an [Issue on the github repo](https://github.com/StarlingUAS/ProjectStarling/issues)
 
 ## License
-This project is released under the MIT license. Please see the [License file](https://github.com/UoBFlightLab/ProjectStarling/blob/master/LICENSE) for more details.
+This project is released under the MIT license. Please see the [License file](https://github.com/StarlingUAS/ProjectStarling/blob/master/LICENSE) for more details.
diff --git a/docs/README.md b/docs/README.md
@@ -12,7 +12,7 @@ This systems provides a number of key features.
 - Built in simulation stack based on Gazebo
 - Quick transition from simulation to flying controllers on real drones.
 
-![Simple Architecture](/img/ArchSimple.jpg)
+![Simple Architecture](img/ArchSimple.jpg)
 
 ## Documentation
 
@@ -43,11 +43,11 @@ By virtue of the architecture, the system also includes failure recovery and det
 ## Contact
 The initial developers of this project are:
 
-- Mickey Li - [email](mailto:[email protected]) - [github](github.com/mhl787156)
-- Robert Clarke - [email](mailto:[email protected]) - [github](github.com/rob-clarke)
+- Mickey Li - [email](mailto:[email protected]) - [github](https://github.com/mhl787156)
+- Robert Clarke - [email](mailto:[email protected]) - [github](https://github.com/rob-clarke)
 
 ## FAQs
-Please see documentation, or raise an [Issue on the github repo](github.com/UoBFlightLab/ProjectStarling/issues)
+Please see documentation, or raise an [Issue on the github repo](https://github.com/StarlingUAS/ProjectStarling/issues)
 
 ## License
-This project is released under the MIT license. Please see the [License file](https://github.com/UoBFlightLab/ProjectStarling/blob/master/LICENSE) for more details.
+This project is released under the MIT license. Please see the [License file](https://github.com/StarlingUAS/ProjectStarling/blob/master/LICENSE) for more details.
diff --git a/docs/kbd.css b/docs/kbd.css
@@ -0,0 +1,13 @@
+kbd > kbd {
+    background-color: #eee;
+    border-radius: 3px;
+    border: 1px solid #b4b4b4;
+    box-shadow: 0 1px 1px rgba(0, 0, 0, .2), 0 2px 0 0 rgba(255, 255, 255, .7) inset;
+    color: #333;
+    display: inline-block;
+    font-size: .85em;
+    font-weight: 700;
+    line-height: 1;
+    padding: 2px 4px;
+    white-space: nowrap;
+   }
diff --git a/docs/other/ideas.md b/docs/other/ideas.md
@@ -1,3 +1,3 @@
-### `ros.env.d`
+# `ros.env.d`
 Adding a folder to a `/ros.env.d` could provide an extendable way to add to the
 ros environment. e.g. including additional model/plugin paths for Gazebo.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,5 @@
 mkdocs
 mkdocs-macros-plugin
+pymdown-extensions
+mkdocs-enumerate-headings-plugin
+mkdocs-mermaid2-plugin
diff --git a/docs/tutorials/imgs/fenswoodgif.gif b/docs/tutorials/imgs/fenswoodgif.gif
diff --git a/docs/tutorials/imgs/fenswoodscreenshot1.png b/docs/tutorials/imgs/fenswoodscreenshot1.png
diff --git a/docs/tutorials/imgs/linux-terminal-on-ubuntu.png b/docs/tutorials/imgs/linux-terminal-on-ubuntu.png
diff --git a/docs/tutorials/imgs/ros2node_topic_and_service.gif b/docs/tutorials/imgs/ros2node_topic_and_service.gif
diff --git a/docs/tutorials/imgs/starling-fenswood-demo-1.gif b/docs/tutorials/imgs/starling-fenswood-demo-1.gif
diff --git a/docs/tutorials/imgs/starling-fenswood-demo-2a.gif b/docs/tutorials/imgs/starling-fenswood-demo-2a.gif
diff --git a/docs/tutorials/imgs/starling-fenswood-demo-2b.gif b/docs/tutorials/imgs/starling-fenswood-demo-2b.gif
diff --git a/docs/tutorials/imgs/ui.png b/docs/tutorials/imgs/ui.png
diff --git a/docs/tutorials/introduction.md b/docs/tutorials/introduction.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,17 +8,26 @@ copyright: Copyright &copy; 2021 University of Bristol Flight Laboratory
 markdown_extensions:
   - toc:
       permalink: True
+  - pymdownx.keys:
+      strict: True
 
 plugins:
   - search
   - macros
+  - enumerate-headings:
+      toc_depth: 3
+  - mermaid2
+
+extra_css: [ kbd.css ]
 
 nav:
   - "Home":
     - "Overview": 'README.md'
     - "Getting Started": 'guide/getting-started.md'
     - "Background": 'details/background.md'
     - "Ecosystem": 'other/related_projects_and_links.md'
+  - "Tutorials":
+    - "Introduction to Starling": 'tutorials/introduction.md'
   - "Single Drone User Guides":
     - "Single Drone Simulation on Local Machine": "guide/single-drone-local-machine.md"
     - "Single Drone Simulation on Local Cluster": "guide/kube-single-drone-local-machine.md"