cleanup structure

Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>

docs/developers/software_reference/index.md

@@ -15,8 +15,7 @@ closing the console before turning it off, and restoring this state
 when opening and turning it back on in a matter of seconds.
 
 This feature is only possible because of the optimized fast boot time
-detailed in the [Boot Process](boot_process/boot_process_intro.md)
+detailed in the [Boot Process][1] section.
-section.
 
 ## Storage
 
@@ -24,8 +23,8 @@ The only storage system available in the **FunKey S** is its
 integrated MicroSD card. Most of its contents is made available to a
 host computer when connected over USB.
 
-The MicroSD card format is detailed in the [Disk
+The MicroSD card format is detailed in the [Disk Partition][2]
-Partition](disk_mapping/partition.md) section.
+section.
 
 ## Video Processing
 
@@ -50,6 +49,9 @@ The **FunKey S** has no standard keyboard but features common
 console-oriented controls in the form of a D-Pad, A/B/X/Y Pad,
 Menu/On/Off, Fn and Start buttons.
 
+[1]: boot_process/index.md
+[2]: disk_mapping/partition_map.md
+
 --8<--
 includes/glossary.md
 --8<--

docs/index.md

@@ -36,9 +36,9 @@ Last but not least, this documentation would not be complete without a
 [Glossary of terms][5] and an [FAQ][6] section for reference.
 
 [1]: quickstart.md
-[2]: tutorials/software/update.md
+[2]: tutorials/software/firmware_update.md
-[3]: developers/hardware_ref/
+[3]: developers/hardware_reference/
-[4]: developers/software_ref/disk_mapping/recovery.md
+[4]: developers/software_reference/disk_mapping/recovery.md
 [5]: miscellaneous/glossary.md
 [6]: miscellaneous/faq.md
 

mkdocs.yml

@@ -46,7 +46,7 @@ plugins:
       glob:
         - tutorials/hardware/force_shutdown.md
         - tutorials/software/restore_games.md
-        - tutorials/software/themes.md
+        - tutorials/software/create_themes.md
 
 # Customization
 extra:
@@ -122,78 +122,78 @@ markdown_extensions:
 # Page tree
 nav:
   - 'Overview': 'index.md'
-  - User's manual:
+  - "User's Manual":
     - 'Quickstart': 'quickstart.md'
-    - Product description:
+    - Product Description:
-      - 'Key mapping': 'features/key_mapping.md'
+      - 'Key Mapping': 'features/key_mapping.md'
       - 'Launchers': 'features/launchers.md'
       - 'Emulators': 'features/emulators.md'
-      - 'Standalone games & applications': 'features/games_apps.md'
+      - 'Standalone Games & Applications': 'features/games_apps.md'
-      - 'FunKey menu': 'features/funkey_menu.md'
+      - 'FunKey Menu': 'features/funkey_menu.md'
-      - 'Folder organization': 'features/folder_organization.md'
+      - 'Folder Organization': 'features/folder_organization.md'
-      - 'Auto save and reload': 'features/quick_save.md'
+      - 'Quick Save': 'features/quick_save.md'
-      - 'Instant action': 'features/instant_action.md'
+      - 'Instant Action': 'features/instant_action.md'
     - Tutorials:
       - Software:
-        - 'Add new ROMs': 'tutorials/software/add_roms.md'
+        - 'Add New ROMs': 'tutorials/software/add_roms.md'
-        - 'Add OPK files': 'tutorials/software/copy_opk.md'
+        - 'Add OPK Files': 'tutorials/software/add_opk.md'
         - 'Install the GBA/PS1 BIOS': 'tutorials/software/gba_bios.md'
-        - 'Change aspect ratio': 'tutorials/software/aspect_ratio.md'
+        - 'Change Aspect Ratio': 'tutorials/software/aspect_ratio.md'
-        - 'Take a snapshot': 'tutorials/software/snapshot.md'
+        - 'Take a Snapshot': 'tutorials/software/snapshot.md'
-        - 'Firmware upgrade': 'tutorials/software/update.md'
+        - 'Firmware Upgrade': 'tutorials/software/firmware_update.md'
-        - 'Change Gameboy palette': 'tutorials/software/gb_palette.md'
+        - 'Change Gameboy Palette': 'tutorials/software/gb_palette.md'
-        # - 'Create themes': 'tutorials/software/themes.md'
+        # - 'Create Themes': 'tutorials/software/create_themes.md'
-        #- 'Restore default games & emulators': 'tutorials/software/restore_games.md'
+        #- 'Restore Default Games & Emulators': 'tutorials/software/restore_games.md'
       - Hardware:
-        - 'Teardown': 'tutorials/hardware/disassembling_console.md'
+        - 'Teardown': 'tutorials/hardware/teardown.md'
-        - 'Flash & Switch micro-SD card': 'tutorials/hardware/change_sd_card.md'
+        - 'Flash & Change micro-SD Card': 'tutorials/hardware/flash_change_sd_card.md'
-        - 'Change the buttons': 'tutorials/hardware/buttons.md'
+        - 'Change the Buttons': 'tutorials/hardware/change_buttons.md'
-       # - 'Force shutdown': 'tutorials/hardware/force_shutdown.md'
+       # - 'Force Shutdown': 'tutorials/hardware/force_shutdown.md'
-  - Developer's Guide:
+  - "Developer's Guide":
-    - Hardware reference:
+    - Hardware Reference:
-      - 'developers/hardware_ref/index.md'
+      - 'developers/hardware_reference/index.md'
-      - 'Architecture': 'developers/hardware_ref/architecture.md'
+      - 'Architecture': 'developers/hardware_reference/architecture.md'
       - 'BOM': 'https://htmlpreview.github.io/?https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/BOM/ibom.html'
-      - 'CPU': 'developers/hardware_ref/cpu.md'
+      - 'CPU': 'developers/hardware_reference/cpu.md'
       - Power:
-        - 'Regulated DC Power Supply Topologies': 'developers/hardware_ref/power/dc-dc.md'
+        - 'Regulated DC Power Supply Topologies': 'developers/hardware_reference/power/power_supplies_topologies.md'
-        - 'Why so many different Power Supply Voltages?': 'developers/hardware_ref/power/voltages.md'
+        - 'Multiple Power Supply Voltages': 'developers/hardware_reference/power/multiple_voltages.md'
-        - 'PMIC': 'developers/hardware_ref/power/pmic.md'
+        - 'PMIC': 'developers/hardware_reference/power/pmic.md'
-        - 'DRAM Power': 'developers/hardware_ref/power/dram.md'
+        - 'DRAM Power': 'developers/hardware_reference/power/dram_power.md'
-        - 'Decoupling' : 'developers/hardware_ref/power/decoupling.md'
+        - 'Decoupling' : 'developers/hardware_reference/power/decoupling.md'
-      - 'Screen': 'developers/hardware_ref/screen.md'
+      - 'Screen': 'developers/hardware_reference/screen.md'
-      - 'Audio': 'developers/hardware_ref/audio.md'
+      - 'Audio': 'developers/hardware_reference/audio.md'
-      - 'Buttons': 'developers/hardware_ref/buttons.md'
+      - 'Buttons': 'developers/hardware_reference/buttons.md'
-      - 'SD Card': 'developers/hardware_ref/sd-card.md'
+      - 'SD Card': 'developers/hardware_reference/sd-card.md'
-      - 'USB': 'developers/hardware_ref/usb.md'
+      - 'USB': 'developers/hardware_reference/usb.md'
-      - 'UART': 'developers/hardware_ref/uart.md'
+      - 'UART': 'developers/hardware_reference/uart.md'
-      - 'Magnetic Switch': 'developers/hardware_ref/magnetic_switch.md'
+      - 'Magnetic Switch': 'developers/hardware_reference/magnetic_switch.md'
-    - Software reference:
+    - Software Reference:
-      - 'developers/software_ref/index.md'
+      - 'developers/software_reference/index.md'
-      - Boot process:
+      - Boot Process:
-        - 'Introduction': 'developers/software_ref/boot_process/boot_process_intro.md'
+        - 'developers/software_reference/boot_process/index.md'
-        - 'Bootloader': 'developers/software_ref/boot_process/bootloader.md'
+        - 'Bootloader': 'developers/software_reference/boot_process/bootloader.md'
-        - 'Kernel': 'developers/software_ref/boot_process/kernel.md'
+        - 'Kernel': 'developers/software_reference/boot_process/kernel.md'
-        - 'Init Scripts': 'developers/software_ref/boot_process/init.md'
+        - 'Init Scripts': 'developers/software_reference/boot_process/init_scripts.md'
-        - 'Shutdown Process': 'developers/software_ref/boot_process/shutdown.md'
+        - 'Shutdown Process': 'developers/software_reference/boot_process/shutdown_process.md'
-      - Disk mapping:
+      - Disk Mapping:
-        - 'Introduction': 'developers/software_ref/disk_mapping/disk_mapping_intro.md'
+        - 'developers/software_reference/disk_mapping/index.md'
-        - 'Partition Map': 'developers/software_ref/disk_mapping/partition.md'
+        - 'Partition Map': 'developers/software_reference/disk_mapping/partition_map.md'
-        - 'Built-in Recovery': 'developers/software_ref/disk_mapping/recovery.md'
+        - 'Recovery': 'developers/software_reference/disk_mapping/recovery.md'
-        - 'Root Filesystem': 'developers/software_ref/disk_mapping/rootfs.md'
+        - 'Root Filesystem': 'developers/software_reference/disk_mapping/root_filesystem.md'
-        - 'USB Shared Partition': 'developers/software_ref/disk_mapping/shared.md'
+        - 'USB Shared Partition': 'developers/software_reference/disk_mapping/usb_shared_partition.md'
-      - 'Video Processing': 'developers/software_ref/video.md'
+      - 'Video Processing': 'developers/software_reference/video_processing.md'
-      - 'Input mapping': 'developers/software_ref/input.md'
+      - 'Input Mapping': 'developers/software_reference/input_mapping.md'
     - Tutorials:
-      - 'Access the Recovery boot mode': 'developers/tutorials/recovery.md'
+      - 'Access the Recovery Boot Mode': 'developers/tutorials/access_recovery.md'
-      - 'SSH connection over USB': 'developers/tutorials/ssh_connection.md'
+      - 'SSH Connection over USB': 'developers/tutorials/ssh_connection.md'
-      - 'Serial connection over UART': 'developers/tutorials/uart_connection.md'
+      - 'Serial Connection over UART': 'developers/tutorials/uart_connection.md'
       - Build System:
-        - 'Introduction': 'developers/tutorials/build_system/build_system_intro.md'
+        - 'developers/tutorials/build_system/index.md'
-        - 'Compilation environments': 'developers/tutorials/build_system/compilation_environments.md'
+        - 'Compilation Environments': 'developers/tutorials/build_system/compilation_environments.md'
-        - 'Compile SDK': 'developers/tutorials/build_system/toolchain.md'
+        - 'Compile SDK': 'developers/tutorials/build_system/compile_sdk.md'
-        - 'Compile distribution': 'developers/tutorials/build_system/build_system.md'
+        - 'Compile Distribution': 'developers/tutorials/build_system/compile_distribution.md'
-      - 'Build programs using SDK': 'developers/tutorials/build_system/build_program_using_sdk.md'
+      - 'Build Programs using SDK': 'developers/tutorials/build_system/build_program_using_sdk.md'
   - Miscellaneous:
     - 'Glossary': 'miscellaneous/glossary.md'
     - 'FAQ': 'miscellaneous/faq.md'