programmer's guide: WIP

ricardoquesada · Apr 30, 2024 · 252c6d4 · 252c6d4
1 parent 346b146
commit 252c6d4
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 10 deletions.
diff --git a/docs/programmers_guide_arduino.md b/docs/programmers_guide_arduino.md
@@ -0,0 +1,3 @@
+# Programmer's Guide: Arduino API
+
+WIP
diff --git a/docs/programmers_guide_circuitpython.md b/docs/programmers_guide_circuitpython.md
@@ -0,0 +1,3 @@
+# Programmer's Guide: CircuitPython API
+
+WIP
diff --git a/docs/programmers_guide.md → docs/programmers_guide_raw.md b/docs/programmers_guide.md → docs/programmers_guide_raw.md
@@ -1,9 +1,7 @@
-# Programmers Guide
+# Programmer's Guide: Raw API
 
 WIP
 
-## Raw API
-
 Valid for Pico-SDK / ESP-IDF
 
 From [BTstack documentation][btstack_multithreading]
@@ -16,7 +14,3 @@ From [BTstack documentation][btstack_multithreading]
 > The called function should check if there are any pending BTstack tasks and execute them.
 
 [btstack_multithreading]: https://github.com/bluekitchen/btstack/blob/master/port/esp32/README.md#multi-threading
-
-## Arduino
-
-## CircuitPython
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -27,12 +27,15 @@ nav:
     - 'Arduino + ESP32 board': plat_arduino.md
     - 'Arduino + NINA-W10 board': plat_nina.md
     - 'CircuitPython + AirLift board': plat_airlift.md
-    - 'ESP32 + ESP-IDF (raw API)': plat_esp32.md
+    - 'ESP32 + ESP-IDF (API)': plat_esp32.md
     - 'Pico W + Pico SDK (raw API)': plat_picow.md
     - 'Unijoysticle board': plat_unijoysticle.md
     - 'MightyMiggy board': plat_mightymiggy.md
-  - Developer:
-    - 'Programmers Guide': programmers_guide.md
+  - "Programmer's Guide":
+    - 'Raw: ESP-IDF / Pico-SDK API': programmers_guide_raw.md
+    - 'Arduino API': programmers_guide_arduino.md
+    - 'CircuitPython API': programmers_guide_circuitpython.md
+  - Developer Notes:
     - 'Flashing firmware': firmware_setup.md
     - adding_new_platform.md
     - 'Architecture': architecture.md