docs: User manual section

docs/badge/assembly.rst

+.. _assembly:
 Assembly
 ========
 

docs/badge/usage.rst

@@ -9,6 +9,8 @@ upwards
 .. image:: overview.svg
   :width: 700px
 
+.. _usage_power:
+
 Powering your Flow3r
 --------------------
 
@@ -20,6 +22,8 @@ right.
 
 You should then see the badge spring to life and display 'Starting...' on the screen.
 
+.. _usage_menu:
+
 Navigating the Menu
 -------------------
 
@@ -30,6 +34,8 @@ in the menu. Pressing it down selects a menu option.
 The OS shoulder button (right shoulder unless swapped in settings) can be
 pressed down to quickly return 'back', either in a menu or an app.
 
+.. _usage_audio:
+
 Dealing with Audio
 ------------------
 
@@ -41,6 +47,8 @@ You can plug in a pair of headphones to the 3.5mm jack on the bottom-left petal.
 The built-in speakers will then turn off and audio will go out through the
 headphones. You can adjust their volume in the same way.
 
+.. _usage_nick:
+
 Showing your nick and pronouns
 ------------------------------
 
@@ -70,6 +78,8 @@ settings) to exit Disk Mode. Then, go to Badge |rarr| Nick to see your changes!
 If the ``nick.json`` file is unparseable or otherwise gets corrupted, it will be
 overwritten with the default contents on next nick app startup.
 
+.. _usage_music:
+
 Playing Music
 -------------
 
@@ -100,7 +110,7 @@ Left/right on the app button sets the step length of the sequencer. If it's a si
 time when passing it. If it's two lines, they will alternate between being solid and missing a piece in the middle; if solid, the sequencer will
 be reset when passing it, if they're "open" they let the sequencer pass through once and switch to solid in the next pass. This is very useful for creating "early reset" type beats and hiding special moments in the last group or so :D.
 
-Your beat is saved when exiting gay drums! Make sure to wait until the menu screen appears before turning the power off though :D!
+Your beat is saved in flash at ``/sys/gay_drums.json`` when exiting gay drums! Make sure to wait until the menu screen appears before turning the power off though :D!
 
 harmonic demo
 ^^^^^^^^^^^^^
@@ -118,7 +128,7 @@ Chord selection is done in 3 different mode, cycle through them with left/right
 If you find yourself lost in ``Chord Selector``, note that intervals from root are color coded on the screen, meaning you can just
 try out what setting changes which petal and feel out how what difference it makes in context of the others!
 
-Your chords are saved when exiting harmonic demo! Make sure to wait until the menu screen appears before turning the power off though :D!
+Your chords are saved in flash at ``/sys/harmonic_demo.json`` when exiting harmonic demo! Make sure to wait until the menu screen appears before turning the power off though :D!
 
 tiny sampler
 ^^^^^^^^^^^^
@@ -134,6 +144,8 @@ through them with left/right on the app button:
 
 Samples are saved in flash at ``/sys/samples/tiny_sample_*.wav``.
 
+.. _usage_apps:
+
 Applications
 ------------
 
@@ -174,6 +186,8 @@ Worms
 
 Touch petals for worms!
 
+.. _usage_system:
+
 System
 ------
 
@@ -190,12 +204,14 @@ Menu for setting various system parameters.
 - ``Debug: ftop``: Prints a task cpu load and memory report every 5 seconds on the USB serial port.
 - ``Touch Overlay``: If a petal is pressed the positional output is displayed in an overlay.
 
-A settings file with more options including headphone and speaker max/min volume and volume adjust step is on the flash filesystem at ``/settings.json``.
+A settings file with more options including headphone and speaker max/min volume and volume
+adjust step is on the flash filesystem at ``/settings.json``.
 
 Graphics Mode
 ^^^^^^^^^^^^^
 
-Various graphics settings. If ``lock`` is enabled applications can not override these, else they can set it to their individual preferences at runtime.
+Various graphics settings. If ``lock`` is enabled applications can not override these,
+else they can set it to their individual preferences at runtime.
 
 Get Apps
 ^^^^^^^^
@@ -212,6 +228,12 @@ Disk Mode (SD)
 
 Make the SD card filesystem accessible as a block device via USB. Reboots on exit.
 
+Yeet local changes
+^^^^^^^^^^^^^^^^^^
+
+Restores python payload to the state of the last firmware updatei and reboots. This excludes
+settings and files not present in the original payload.
+
 Reboot
 ^^^^^^
 

docs/index.rst

@@ -6,13 +6,31 @@
 Welcome to flow3r's documentation!
 ==================================
 
+User manual
+-----------
+
+* :ref:`Assembly <assembly>`
+* :ref:`Power <usage_power>`
+* :ref:`Menu <usage_menu>`
+* :ref:`Audio <usage_audio>`
+* :ref:`Nick <usage_nick>`
+* :ref:`Music <usage_music>`
+* :ref:`Apps <usage_apps>`
+* :ref:`System <usage_system>`
+
 .. toctree::
    :maxdepth: 1
-   :caption: The badge:
+   :hidden:
+   :caption: User manual
 
-   badge/hardware_specs.rst
    badge/assembly.rst
    badge/usage.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Programming guide
+
+   badge/hardware_specs.rst
    badge/programming.rst
    badge/firmware.rst
    badge/firmware-development.rst
@@ -23,7 +41,7 @@ Welcome to flow3r's documentation!
 
 .. toctree::
    :maxdepth: 1
-   :caption: API:
+   :caption: API
 
    api/audio.rst
    api/badgelink.rst
@@ -38,12 +56,12 @@ Welcome to flow3r's documentation!
 
 .. toctree::
    :maxdepth: 1
-   :caption: About:
+   :caption: About
 
    badge/license.rst
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`