Add navigation

AgOpenGPS-Official · Dec 21, 2024 · b18c352 · b18c352
1 parent e2558b9
commit b18c352
Show file tree

Hide file tree

Showing 28 changed files with 92 additions and 63 deletions.
diff --git a/docs/hardware/AIO-Board-flavours.md → docs/hardware/AIO-Board-flavours/index.md b/docs/hardware/AIO-Board-flavours.md → docs/hardware/AIO-Board-flavours/index.md
diff --git a/docs/hardware/v2.x-board-issues---fixes.md → ...ard-flavours/v2.x-board-issues---fixes.md b/docs/hardware/v2.x-board-issues---fixes.md → ...ard-flavours/v2.x-board-issues---fixes.md
diff --git a/...rdware/v4.x-AIO-board-issues-and-fixes.md → ...avours/v4.x-AIO-board-issues-and-fixes.md b/...rdware/v4.x-AIO-board-issues-and-fixes.md → ...avours/v4.x-AIO-board-issues-and-fixes.md
diff --git a/docs/hardware/Connector-Accessories.md → ...dware/Connectors/Connector-Accessories.md b/docs/hardware/Connector-Accessories.md → ...dware/Connectors/Connector-Accessories.md
diff --git a/docs/hardware/Connectors.md → docs/hardware/Connectors/index.md b/docs/hardware/Connectors.md → docs/hardware/Connectors/index.md
diff --git a/...rdware/help-i-need-to-speak-to-someone.md → ...re/FAQ/help-i-need-to-speak-to-someone.md b/...rdware/help-i-need-to-speak-to-someone.md → ...re/FAQ/help-i-need-to-speak-to-someone.md
diff --git a/docs/hardware/FAQ.md → docs/hardware/FAQ/index.md b/docs/hardware/FAQ.md → docs/hardware/FAQ/index.md
@@ -4,11 +4,11 @@
 ### Please note - these are mostly placeholders at this time; they will be filled in in due course. If you can help with text, or want to suggest other topics, please do so in the Discourse.
 
   * [Help! I need to speak to someone!](help-i-need-to-speak-to-someone.md)
-  * [AGIO](agio.md)
+  * AGIO
     * [UDP](udp.md)
     * [RTK/NTRIP corrections](rtk-ntrip-corrections.md)
     * [Serial/COM ports](serial-com-ports.md)
-    * [AgIO and AgOpenGPS - networking](agio-and-agopengps-networking.md)
+    * [AgIO and AgOpenGPS - networking](../networking/index.md)
   * AgOpenGPS
     * [Is AGIO running? AgIO?](is-agio-running-agio.md)
   * U-blox F9P

diff --git a/docs/hardware/is-agio-running-agio.md → docs/hardware/FAQ/is-agio-running-agio.md b/docs/hardware/is-agio-running-agio.md → docs/hardware/FAQ/is-agio-running-agio.md
diff --git a/docs/hardware/rtk-ntrip-corrections.md → docs/hardware/FAQ/rtk-ntrip-corrections.md b/docs/hardware/rtk-ntrip-corrections.md → docs/hardware/FAQ/rtk-ntrip-corrections.md
diff --git a/docs/hardware/serial-com-ports.md → docs/hardware/FAQ/serial-com-ports.md b/docs/hardware/serial-com-ports.md → docs/hardware/FAQ/serial-com-ports.md
diff --git a/docs/hardware/swapping-gps-ports.md → docs/hardware/FAQ/swapping-gps-ports.md b/docs/hardware/swapping-gps-ports.md → docs/hardware/FAQ/swapping-gps-ports.md
diff --git a/docs/hardware/udp.md → docs/hardware/FAQ/udp.md b/docs/hardware/udp.md → docs/hardware/FAQ/udp.md
diff --git a/docs/hardware/ProblemsAndSolutions.md b/docs/hardware/ProblemsAndSolutions.md
@@ -1,4 +1,4 @@
 ## Got a problem? Hopefully you'll find the solution here!
 
 ### Hardware
-  * [U-Center can't update the F9P firmware](u-center-cant-update-the-f9p-firmware.md)
+  * U-Center can't update the F9P firmware (TODO)
diff --git a/docs/hardware/Putting-It-All-Together.md b/docs/hardware/Putting-It-All-Together.md
diff --git a/docs/hardware/PuttingItAllTogether.md b/docs/hardware/PuttingItAllTogether.md
diff --git a/docs/hardware/agio-and-agopengps-networking.md b/docs/hardware/agio-and-agopengps-networking.md
diff --git a/docs/hardware/agio.md b/docs/hardware/agio.md
diff --git a/docs/hardware/Reading-LEDs.md → ...rdware/assemblingtheboard/Reading-LEDs.md b/docs/hardware/Reading-LEDs.md → ...rdware/assemblingtheboard/Reading-LEDs.md
diff --git a/...hardware/components-you-can-do-without.md → ...theboard/components-you-can-do-without.md b/...hardware/components-you-can-do-without.md → ...theboard/components-you-can-do-without.md
diff --git a/...ware/electrical-testing-and-validation.md → ...oard/electrical-testing-and-validation.md b/...ware/electrical-testing-and-validation.md → ...oard/electrical-testing-and-validation.md
diff --git a/docs/hardware/assemblingtheboard.md → docs/hardware/assemblingtheboard/index.md b/docs/hardware/assemblingtheboard.md → docs/hardware/assemblingtheboard/index.md
diff --git a/docs/hardware/miscellaneous.md b/docs/hardware/miscellaneous.md
diff --git a/docs/hardware/networking.md → docs/hardware/networking/index.md b/docs/hardware/networking.md → docs/hardware/networking/index.md
diff --git a/docs/hardware/other-guides-and-resources.md b/docs/hardware/other-guides-and-resources.md
diff --git a/docs/hardware/problems.md b/docs/hardware/problems.md
diff --git a/docs/hardware/u-center-cant-update-the-f9p-firmware.md b/docs/hardware/u-center-cant-update-the-f9p-firmware.md
diff --git a/docs/hardware/wiki.md b/docs/hardware/wiki.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,84 @@
 site_name: AgOpenGPS Documentation
 
+nav:
+  - Home: index.md
+  - Software:
+    - What is AgOpenGPS?: software/01.-What-is-AgOpenGPS?.md
+    - Install AgOpenGPS and AgIO: software/02.-Install-AgOpenGPS-and-AgIO.md
+    - AgIO Orientation: software/03.-AgIO-Orientation.md
+    - AgOpenGPS Orientation: software/04.-AgOpenGPS-Orientation.md
+    - Ethernet Setup: software/05.-Ethernet-Setup.md
+    - RTK Setup: software/06.-RTK-Setup.md
+    - UDP Monitor: software/07.-UDP-Monitor.md
+    - Serial Monitor: software/08.-Serial-Monitor.md
+    - ChangeLog: software/ChangeLog.md
+    - FAQ: software/FAQ.md
+  - Hardware:
+    - Hardware that's needed: hardware/tl-dr-cut-to-the-chase-what-do-i-buy.md
+    - Boards - All-In-One:
+      - All-In-One Board versions and how to order:
+        - hardware/AIO-Board-flavours/index.md
+        - AIO v2.x issues and fixes: hardware/AIO-Board-flavours/v2.x-board-issues---fixes.md
+        - AIO v4.x issues and fixes: hardware/AIO-Board-flavours/v4.x-AIO-board-issues-and-fixes.md
+      - Assembling the board:
+        - hardware/assemblingtheboard/index.md
+        - Components you can do without: hardware/assemblingtheboard/components-you-can-do-without.md
+        - Electrical testing and validation: hardware/assemblingtheboard/electrical-testing-and-validation.md
+        - Reading LEDs: hardware/assemblingtheboard/Reading-LEDs.md
+      - Other pieces to be able to assemble: hardware/AIO-other-pieces.md
+      - Ampseal 23 pinout: hardware/AIO-Board-Pinout.md
+      - Ampseal-Wiring-Harness example: hardware/AIO--Ampseal-Wiring-Harness.md
+    - Boards - Others:
+      - Brians old board: hardware/02-Build-Version-2-Steer-Board.md
+      - Legacy solutions: https://github.com/AgHardware/Boards/tree/main/ArduinoModules
+      - Enclosures: hardware/Enclosures.md
+    - Implement Boards:
+      - Machine Board for relay control: hardware/Machine-Board.md
+      - Machine board - full guide: hardware/Machineboardguide.md
+      - Rate Controller for variable rate and section: https://github.com/SK21/AOG_RC
+    - Other components:
+      - GNSS / GPS - ZED-F9P: hardware/gps-modules-standard-or-micro.md
+      - GNSS Antenna: hardware/Choosing-an-Antenna.md
+      - Teensy 4.1 a.k.a the brain of the board: hardware/teensy-4.1.md
+      - IMU for roll compensation: hardware/imu-inertial-measurement-unit.md
+      - Wheel Angle Sensor: hardware/wheel-angle-sensor.md
+      - Windows Tablet: hardware/tablet.md
+      - Cytron MD13S driver: hardware/cytron-motor-driver.md
+      - Steering with Motor: hardware/the-motor.md
+      - Steering with Baraki hydraulic block: hardware/Hydraulic-steering-with-baraki-valve.md
+      - Steering via CAN bus: hardware/CANBUS.md
+      - Steering via Danfoss: hardware/Danfoss.md
+      - Steering with Keya CANBUS wheel: hardware/Keya.md
+      - Connectors:
+        - hardware/Connectors/index.md
+        - Connector Accessories: hardware/Connectors/Connector-Accessories.md
+      - Cabling and Wiring: hardware/CablingWiring.md
+      - Miscellaneous hardware: hardware/MiscHardware.md
+    - Boards - Configuration:
+      - Configuring the ZED-F9P GPS: hardware/configuring-the-zed-f9p.md
+      - Configuring the Teensy: hardware/Configuring-The-Teensy.md
+      - Configuring your tablet: hardware/configuring-your-tablet.md
+    - Suppliers of full systems: hardware/suppliers.md
+    - SCAMMERS: hardware/SCAMMERS.md
+    - Networking:
+      - hardware/networking/index.md
+      - Ethernet Setup: software/05.-Ethernet-Setup.md
+    - Video Guides: hardware/videoguides.md
+    - 🤩 AgOpenGPS - a guide for machine-users: software/04.-AgOpenGPS-Orientation.md
+    - 🚜 The Manual: hardware/TheManual.md
+    - 🤯 Frequently Asked Questions:
+      - hardware/FAQ/index.md
+      - Help! I need to speak to someone!: hardware/FAQ/help-i-need-to-speak-to-someone.md
+      - Is AGIO running? AgIO?: hardware/FAQ/is-agio-running-agio.md
+      - UDP: hardware/FAQ/udp.md
+      - RTK/NTRIP corrections: hardware/FAQ/rtk-ntrip-corrections.md
+      - Serial/COM ports: hardware/FAQ/serial-com-ports.md
+      - Swapping GPS ports: hardware/FAQ/swapping-gps-ports.md
+    - 🤬 Problems and Solutions: hardware/ProblemsAndSolutions.md
+    - Other cool open-source Ag projects: hardware/otherprojects.md
+    - 3D prints and designs: hardware/3dprints.md
+    - Other references: hardware/otherrefs.md
+
 theme:
   name: material
   palette:
@@ -15,3 +94,13 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
+  features:
+    - navigation.expand
+    - navigation.indexes
+    - navigation.sections
+    - navigation.tabs
+
+markdown_extensions:
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg