Merge pull request #1093 from bitcraze/krichardsson/new-menu

Using new documentation menu format
bitcraze · Aug 15, 2022 · 7b81901 · 7b81901
2 parents 59044ce + d7428a5
commit 7b81901
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 52 deletions.
diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,9 @@
+---
+title: Auto-generated API Documentation
+page_id: api_index
+sort_order: 5
+---
+
+This section contains auto-generated documentation for the logging- and parameter variables that are supported.
+
+{% sub_page_menu %}
diff --git a/docs/building-and-flashing/index.md b/docs/building-and-flashing/index.md
@@ -0,0 +1,9 @@
+---
+title: Building and flashing
+page_id: building_and_flashing_index
+sort_order: 1
+---
+
+This section contains instructions on how to build and flash
+
+{% sub_page_menu %}
diff --git a/docs/development/index.md b/docs/development/index.md
@@ -0,0 +1,9 @@
+---
+title: Development Instructions
+page_id: development_index
+sort_order: 4
+---
+
+This section contains instructions on how to write and modify the source code for the firmware.
+
+{% sub_page_menu %}
diff --git a/docs/functional-areas/index.md b/docs/functional-areas/index.md
@@ -0,0 +1,9 @@
+---
+title: Functional areas
+page_id: functional_areas_index
+sort_order: 3
+---
+
+This section describes the functionality of various parts of the system.
+
+{% sub_page_menu %}
diff --git a/docs/functional-areas/memory-subsystem/index.md b/docs/functional-areas/memory-subsystem/index.md
@@ -22,15 +22,4 @@ initiated from a client.
 
 ## Memory types and mappings
 
-* [EEPROM - MEM_TYPE_EEPROM](./MEM_TYPE_EEPROM.md)
-* [One wire memory - MEM_TYPE_OW](MEM_TYPE_OW.md)
-* [LED ring - MEM_TYPE_LED12](MEM_TYPE_LED12.md)
-* [Loco Positioning System 1 - MEM_TYPE_LOCO](MEM_TYPE_LOCO.md)
-* [Trajectory - MEM_TYPE_TRAJ](MEM_TYPE_TRAJ.md)
-* [Loco Positioning System 2 - MEM_TYPE_LOCO2](MEM_TYPE_LOCO2.md)
-* [Lighthouse - MEM_TYPE_LH](MEM_TYPE_LH.md)
-* [Test - MEM_TYPE_TESTER](MEM_TYPE_TESTER.md)
-* [uSD card - MEM_TYPE_USD](MEM_TYPE_USD.md)
-* [LED ring timing - MEM_TYPE_LEDMEM](MEM_TYPE_LEDMEM.md)
-* [Generic application memory - MEM_TYPE_APP](MEM_TYPE_APP.md)
-* [Deck memory - MEM_TYPE_DECK_MEM](MEM_TYPE_DECK_MEM.md)
+{% sub_page_menu %}
diff --git a/docs/userguides/index.md b/docs/userguides/index.md
@@ -0,0 +1,9 @@
+---
+title: Userguides
+page_id: userguides_index
+sort_order: 2
+---
+
+In this section you will find user guides
+
+{% sub_page_menu %}