Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using new documentation menu format #1093

Merged
merged 1 commit into from
Aug 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 0 additions & 40 deletions docs/_data/menu.yml

This file was deleted.

9 changes: 9 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -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 %}
9 changes: 9 additions & 0 deletions docs/building-and-flashing/index.md
Original file line number Diff line number Diff line change
@@ -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 %}
9 changes: 9 additions & 0 deletions docs/development/index.md
Original file line number Diff line number Diff line change
@@ -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 %}
9 changes: 9 additions & 0 deletions docs/functional-areas/index.md
Original file line number Diff line number Diff line change
@@ -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 %}
13 changes: 1 addition & 12 deletions docs/functional-areas/memory-subsystem/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
9 changes: 9 additions & 0 deletions docs/userguides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Userguides
page_id: userguides_index
sort_order: 2
---

In this section you will find user guides

{% sub_page_menu %}