From cb7874fb124b87d0ca03d9db98fc336c2e228ca0 Mon Sep 17 00:00:00 2001 From: Vincent-FK Date: Tue, 19 Jan 2021 18:11:40 +0100 Subject: [PATCH] new file architecture (with files added) --- .../architecture.md | 0 .../{hardware => hardware_ref}/audio.md | 0 .../{hardware => hardware_ref}/buttons.md | 0 .../{hardware => hardware_ref}/cpu.md | 0 .../{hardware => hardware_ref}/design.md | 0 .../magnetic_switch.md | 0 .../{hardware => hardware_ref}/power/dc-dc.md | 0 .../power/decoupling.md | 0 .../{hardware => hardware_ref}/power/dram.md | 0 .../{hardware => hardware_ref}/power/pmic.md | 0 .../power/voltages.md | 0 .../{hardware => hardware_ref}/screen.md | 0 .../{hardware => hardware_ref}/sd-card.md | 0 .../{hardware => hardware_ref}/uart.md | 0 .../{hardware => hardware_ref}/usb.md | 0 docs/developers/software/system/shutdown.md | 0 .../system => software_ref}/architecture.md | 4 +- .../boot_process/boot_process_intro.md} | 0 .../software_ref/boot_process/bootloader.md | 4 + .../boot_process}/init.md | 0 .../boot_process}/kernel.md | 0 .../software_ref/boot_process/shutdown.md | 4 + .../disk_mapping/disk_mapping_intro.md} | 0 .../disk_mapping}/partition.md | 0 .../disk_mapping}/recovery.md | 0 .../disk_mapping}/rootfs.md | 0 .../disk_mapping}/shared.md | 0 .../toolchain.md => software_ref/input.md} | 0 .../applications => software_ref}/video.md | 0 .../build_system/build_program_using_sdk.md | 4 + .../tutorials/build_system/build_system.md | 4 + .../build_system/build_system_intro.md} | 0 .../build_system/compilation_environments.md | 4 + .../tutorials/build_system/toolchain.md} | 0 docs/{ => developers}/tutorials/recovery.md | 8 +- docs/developers/tutorials/ssh_connection.md | 4 + docs/developers/tutorials/uart_connection.md | 4 + docs/features/emulators.md | 4 + docs/features/folder_organization.md | 4 + docs/features/funkey_menu.md | 4 + docs/features/games_apps.md | 4 + docs/features/instant_action.md | 4 + docs/features/key_mapping.md | 4 + docs/features/launchers.md | 4 + docs/features/quick_save.md | 4 + docs/index.md | 6 +- docs/tutorials/hardware/buttons.md | 5 + docs/tutorials/hardware/change_sd_card.md | 4 + docs/tutorials/hardware/force_shutdown.md | 4 + docs/tutorials/hardware/open_console.md | 4 + docs/tutorials/software/add_roms.md | 4 + docs/tutorials/software/aspect_ratio.md | 4 + .../software/copy_opk.md} | 0 docs/tutorials/{ => software}/gba_bios.md | 0 docs/tutorials/software/restore_games.md | 4 + docs/tutorials/software/snapshot.md | 4 + docs/tutorials/{ => software}/themes.md | 0 docs/tutorials/{ => software}/update.md | 0 mkdocs.yml | 114 +++++++++++------- 59 files changed, 172 insertions(+), 53 deletions(-) rename docs/developers/{hardware => hardware_ref}/architecture.md (100%) rename docs/developers/{hardware => hardware_ref}/audio.md (100%) rename docs/developers/{hardware => hardware_ref}/buttons.md (100%) rename docs/developers/{hardware => hardware_ref}/cpu.md (100%) rename docs/developers/{hardware => hardware_ref}/design.md (100%) rename docs/developers/{hardware => hardware_ref}/magnetic_switch.md (100%) rename docs/developers/{hardware => hardware_ref}/power/dc-dc.md (100%) rename docs/developers/{hardware => hardware_ref}/power/decoupling.md (100%) rename docs/developers/{hardware => hardware_ref}/power/dram.md (100%) rename docs/developers/{hardware => hardware_ref}/power/pmic.md (100%) rename docs/developers/{hardware => hardware_ref}/power/voltages.md (100%) rename docs/developers/{hardware => hardware_ref}/screen.md (100%) rename docs/developers/{hardware => hardware_ref}/sd-card.md (100%) rename docs/developers/{hardware => hardware_ref}/uart.md (100%) rename docs/developers/{hardware => hardware_ref}/usb.md (100%) delete mode 100644 docs/developers/software/system/shutdown.md rename docs/developers/{software/system => software_ref}/architecture.md (93%) rename docs/developers/{software/applications/build_system.md => software_ref/boot_process/boot_process_intro.md} (100%) create mode 100644 docs/developers/software_ref/boot_process/bootloader.md rename docs/developers/{software/system => software_ref/boot_process}/init.md (100%) rename docs/developers/{software/system => software_ref/boot_process}/kernel.md (100%) create mode 100644 docs/developers/software_ref/boot_process/shutdown.md rename docs/developers/{software/applications/input.md => software_ref/disk_mapping/disk_mapping_intro.md} (100%) rename docs/developers/{software/system => software_ref/disk_mapping}/partition.md (100%) rename docs/developers/{software/system => software_ref/disk_mapping}/recovery.md (100%) rename docs/developers/{software/system => software_ref/disk_mapping}/rootfs.md (100%) rename docs/developers/{software/system => software_ref/disk_mapping}/shared.md (100%) rename docs/developers/{software/applications/toolchain.md => software_ref/input.md} (100%) rename docs/developers/{software/applications => software_ref}/video.md (100%) create mode 100644 docs/developers/tutorials/build_system/build_program_using_sdk.md create mode 100644 docs/developers/tutorials/build_system/build_system.md rename docs/developers/{software/system/bootprocess.md => tutorials/build_system/build_system_intro.md} (100%) create mode 100644 docs/developers/tutorials/build_system/compilation_environments.md rename docs/{tutorials/buttons.md => developers/tutorials/build_system/toolchain.md} (100%) rename docs/{ => developers}/tutorials/recovery.md (76%) create mode 100644 docs/developers/tutorials/ssh_connection.md create mode 100644 docs/developers/tutorials/uart_connection.md create mode 100644 docs/features/emulators.md create mode 100644 docs/features/folder_organization.md create mode 100644 docs/features/funkey_menu.md create mode 100644 docs/features/games_apps.md create mode 100644 docs/features/instant_action.md create mode 100644 docs/features/key_mapping.md create mode 100644 docs/features/launchers.md create mode 100644 docs/features/quick_save.md create mode 100644 docs/tutorials/hardware/buttons.md create mode 100644 docs/tutorials/hardware/change_sd_card.md create mode 100644 docs/tutorials/hardware/force_shutdown.md create mode 100644 docs/tutorials/hardware/open_console.md create mode 100644 docs/tutorials/software/add_roms.md create mode 100644 docs/tutorials/software/aspect_ratio.md rename docs/{developers/software/system/bootloader.md => tutorials/software/copy_opk.md} (100%) rename docs/tutorials/{ => software}/gba_bios.md (100%) create mode 100644 docs/tutorials/software/restore_games.md create mode 100644 docs/tutorials/software/snapshot.md rename docs/tutorials/{ => software}/themes.md (100%) rename docs/tutorials/{ => software}/update.md (100%) diff --git a/docs/developers/hardware/architecture.md b/docs/developers/hardware_ref/architecture.md similarity index 100% rename from docs/developers/hardware/architecture.md rename to docs/developers/hardware_ref/architecture.md diff --git a/docs/developers/hardware/audio.md b/docs/developers/hardware_ref/audio.md similarity index 100% rename from docs/developers/hardware/audio.md rename to docs/developers/hardware_ref/audio.md diff --git a/docs/developers/hardware/buttons.md b/docs/developers/hardware_ref/buttons.md similarity index 100% rename from docs/developers/hardware/buttons.md rename to docs/developers/hardware_ref/buttons.md diff --git a/docs/developers/hardware/cpu.md b/docs/developers/hardware_ref/cpu.md similarity index 100% rename from docs/developers/hardware/cpu.md rename to docs/developers/hardware_ref/cpu.md diff --git a/docs/developers/hardware/design.md b/docs/developers/hardware_ref/design.md similarity index 100% rename from docs/developers/hardware/design.md rename to docs/developers/hardware_ref/design.md diff --git a/docs/developers/hardware/magnetic_switch.md b/docs/developers/hardware_ref/magnetic_switch.md similarity index 100% rename from docs/developers/hardware/magnetic_switch.md rename to docs/developers/hardware_ref/magnetic_switch.md diff --git a/docs/developers/hardware/power/dc-dc.md b/docs/developers/hardware_ref/power/dc-dc.md similarity index 100% rename from docs/developers/hardware/power/dc-dc.md rename to docs/developers/hardware_ref/power/dc-dc.md diff --git a/docs/developers/hardware/power/decoupling.md b/docs/developers/hardware_ref/power/decoupling.md similarity index 100% rename from docs/developers/hardware/power/decoupling.md rename to docs/developers/hardware_ref/power/decoupling.md diff --git a/docs/developers/hardware/power/dram.md b/docs/developers/hardware_ref/power/dram.md similarity index 100% rename from docs/developers/hardware/power/dram.md rename to docs/developers/hardware_ref/power/dram.md diff --git a/docs/developers/hardware/power/pmic.md b/docs/developers/hardware_ref/power/pmic.md similarity index 100% rename from docs/developers/hardware/power/pmic.md rename to docs/developers/hardware_ref/power/pmic.md diff --git a/docs/developers/hardware/power/voltages.md b/docs/developers/hardware_ref/power/voltages.md similarity index 100% rename from docs/developers/hardware/power/voltages.md rename to docs/developers/hardware_ref/power/voltages.md diff --git a/docs/developers/hardware/screen.md b/docs/developers/hardware_ref/screen.md similarity index 100% rename from docs/developers/hardware/screen.md rename to docs/developers/hardware_ref/screen.md diff --git a/docs/developers/hardware/sd-card.md b/docs/developers/hardware_ref/sd-card.md similarity index 100% rename from docs/developers/hardware/sd-card.md rename to docs/developers/hardware_ref/sd-card.md diff --git a/docs/developers/hardware/uart.md b/docs/developers/hardware_ref/uart.md similarity index 100% rename from docs/developers/hardware/uart.md rename to docs/developers/hardware_ref/uart.md diff --git a/docs/developers/hardware/usb.md b/docs/developers/hardware_ref/usb.md similarity index 100% rename from docs/developers/hardware/usb.md rename to docs/developers/hardware_ref/usb.md diff --git a/docs/developers/software/system/shutdown.md b/docs/developers/software/system/shutdown.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/developers/software/system/architecture.md b/docs/developers/software_ref/architecture.md similarity index 93% rename from docs/developers/software/system/architecture.md rename to docs/developers/software_ref/architecture.md index dcacfa2..f3513a3 100644 --- a/docs/developers/software/system/architecture.md +++ b/docs/developers/software_ref/architecture.md @@ -15,7 +15,7 @@ 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](bootprocess.md) section. +detailed in the [Boot Process](boot_process/boot_process_intro.md) section. ## Storage @@ -24,7 +24,7 @@ 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 -Partition](partition.md) section. +Partition](disk_mapping/partition.md) section. ## Video Processing diff --git a/docs/developers/software/applications/build_system.md b/docs/developers/software_ref/boot_process/boot_process_intro.md similarity index 100% rename from docs/developers/software/applications/build_system.md rename to docs/developers/software_ref/boot_process/boot_process_intro.md diff --git a/docs/developers/software_ref/boot_process/bootloader.md b/docs/developers/software_ref/boot_process/bootloader.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/developers/software_ref/boot_process/bootloader.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/developers/software/system/init.md b/docs/developers/software_ref/boot_process/init.md similarity index 100% rename from docs/developers/software/system/init.md rename to docs/developers/software_ref/boot_process/init.md diff --git a/docs/developers/software/system/kernel.md b/docs/developers/software_ref/boot_process/kernel.md similarity index 100% rename from docs/developers/software/system/kernel.md rename to docs/developers/software_ref/boot_process/kernel.md diff --git a/docs/developers/software_ref/boot_process/shutdown.md b/docs/developers/software_ref/boot_process/shutdown.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/developers/software_ref/boot_process/shutdown.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/developers/software/applications/input.md b/docs/developers/software_ref/disk_mapping/disk_mapping_intro.md similarity index 100% rename from docs/developers/software/applications/input.md rename to docs/developers/software_ref/disk_mapping/disk_mapping_intro.md diff --git a/docs/developers/software/system/partition.md b/docs/developers/software_ref/disk_mapping/partition.md similarity index 100% rename from docs/developers/software/system/partition.md rename to docs/developers/software_ref/disk_mapping/partition.md diff --git a/docs/developers/software/system/recovery.md b/docs/developers/software_ref/disk_mapping/recovery.md similarity index 100% rename from docs/developers/software/system/recovery.md rename to docs/developers/software_ref/disk_mapping/recovery.md diff --git a/docs/developers/software/system/rootfs.md b/docs/developers/software_ref/disk_mapping/rootfs.md similarity index 100% rename from docs/developers/software/system/rootfs.md rename to docs/developers/software_ref/disk_mapping/rootfs.md diff --git a/docs/developers/software/system/shared.md b/docs/developers/software_ref/disk_mapping/shared.md similarity index 100% rename from docs/developers/software/system/shared.md rename to docs/developers/software_ref/disk_mapping/shared.md diff --git a/docs/developers/software/applications/toolchain.md b/docs/developers/software_ref/input.md similarity index 100% rename from docs/developers/software/applications/toolchain.md rename to docs/developers/software_ref/input.md diff --git a/docs/developers/software/applications/video.md b/docs/developers/software_ref/video.md similarity index 100% rename from docs/developers/software/applications/video.md rename to docs/developers/software_ref/video.md diff --git a/docs/developers/tutorials/build_system/build_program_using_sdk.md b/docs/developers/tutorials/build_system/build_program_using_sdk.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/developers/tutorials/build_system/build_program_using_sdk.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/developers/tutorials/build_system/build_system.md b/docs/developers/tutorials/build_system/build_system.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/developers/tutorials/build_system/build_system.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/developers/software/system/bootprocess.md b/docs/developers/tutorials/build_system/build_system_intro.md similarity index 100% rename from docs/developers/software/system/bootprocess.md rename to docs/developers/tutorials/build_system/build_system_intro.md diff --git a/docs/developers/tutorials/build_system/compilation_environments.md b/docs/developers/tutorials/build_system/compilation_environments.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/developers/tutorials/build_system/compilation_environments.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/tutorials/buttons.md b/docs/developers/tutorials/build_system/toolchain.md similarity index 100% rename from docs/tutorials/buttons.md rename to docs/developers/tutorials/build_system/toolchain.md diff --git a/docs/tutorials/recovery.md b/docs/developers/tutorials/recovery.md similarity index 76% rename from docs/tutorials/recovery.md rename to docs/developers/tutorials/recovery.md index 9c55f17..a0aea94 100644 --- a/docs/tutorials/recovery.md +++ b/docs/developers/tutorials/recovery.md @@ -1,4 +1,4 @@ - ---8<-- -includes/glossary.md ---8<-- + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/developers/tutorials/ssh_connection.md b/docs/developers/tutorials/ssh_connection.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/developers/tutorials/ssh_connection.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/developers/tutorials/uart_connection.md b/docs/developers/tutorials/uart_connection.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/developers/tutorials/uart_connection.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/emulators.md b/docs/features/emulators.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/emulators.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/folder_organization.md b/docs/features/folder_organization.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/folder_organization.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/funkey_menu.md b/docs/features/funkey_menu.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/funkey_menu.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/games_apps.md b/docs/features/games_apps.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/games_apps.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/instant_action.md b/docs/features/instant_action.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/instant_action.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/key_mapping.md b/docs/features/key_mapping.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/key_mapping.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/launchers.md b/docs/features/launchers.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/launchers.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/features/quick_save.md b/docs/features/quick_save.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/features/quick_save.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 00d7232..b9941fa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,9 +35,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/update.md -[3]: developers/hardware/design.md -[4]: developers/software/system/recovery.md +[2]: tutorials/software/update.md +[3]: developers/hardware_ref/design.md +[4]: developers/software_ref/disk_mapping/recovery.md [5]: miscellaneous/glossary.md [6]: miscellaneous/faq.md diff --git a/docs/tutorials/hardware/buttons.md b/docs/tutorials/hardware/buttons.md new file mode 100644 index 0000000..1636abd --- /dev/null +++ b/docs/tutorials/hardware/buttons.md @@ -0,0 +1,5 @@ + +--8<-- +includes/glossary.md +--8<-- + diff --git a/docs/tutorials/hardware/change_sd_card.md b/docs/tutorials/hardware/change_sd_card.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/tutorials/hardware/change_sd_card.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/tutorials/hardware/force_shutdown.md b/docs/tutorials/hardware/force_shutdown.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/tutorials/hardware/force_shutdown.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/tutorials/hardware/open_console.md b/docs/tutorials/hardware/open_console.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/tutorials/hardware/open_console.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/tutorials/software/add_roms.md b/docs/tutorials/software/add_roms.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/tutorials/software/add_roms.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/tutorials/software/aspect_ratio.md b/docs/tutorials/software/aspect_ratio.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/tutorials/software/aspect_ratio.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/developers/software/system/bootloader.md b/docs/tutorials/software/copy_opk.md similarity index 100% rename from docs/developers/software/system/bootloader.md rename to docs/tutorials/software/copy_opk.md diff --git a/docs/tutorials/gba_bios.md b/docs/tutorials/software/gba_bios.md similarity index 100% rename from docs/tutorials/gba_bios.md rename to docs/tutorials/software/gba_bios.md diff --git a/docs/tutorials/software/restore_games.md b/docs/tutorials/software/restore_games.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/tutorials/software/restore_games.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/tutorials/software/snapshot.md b/docs/tutorials/software/snapshot.md new file mode 100644 index 0000000..a0aea94 --- /dev/null +++ b/docs/tutorials/software/snapshot.md @@ -0,0 +1,4 @@ + +--8<-- +includes/glossary.md +--8<-- \ No newline at end of file diff --git a/docs/tutorials/themes.md b/docs/tutorials/software/themes.md similarity index 100% rename from docs/tutorials/themes.md rename to docs/tutorials/software/themes.md diff --git a/docs/tutorials/update.md b/docs/tutorials/software/update.md similarity index 100% rename from docs/tutorials/update.md rename to docs/tutorials/software/update.md diff --git a/mkdocs.yml b/mkdocs.yml index 46a2b34..56b7d5b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -102,52 +102,78 @@ markdown_extensions: # Page tree nav: - - Overview: index.md - - Quickstart: 'quickstart.md' - - Tutorials: - - 'Firmware upgrade': 'tutorials/update.md' - - 'Install the GBA BIOS': 'tutorials/gba_bios.md' - - 'Change the buttons': 'tutorials/buttons.md' - - 'Access the built-in Recovery': 'tutorials/recovery.md' - - 'Create themes': 'tutorials/themes.md' + - 'Overview': 'index.md' + - User's manual: + - 'Quickstart': 'quickstart.md' + - Product's description: + - 'Key mapping': 'features/key_mapping.md' + - 'Launchers': 'features/launchers.md' + - 'Emulators': 'features/emulators.md' + - 'Standalone games & applications': 'features/games_apps.md' + - 'FunKey menu': 'features/funkey_menu.md' + - 'Folder organization': 'features/folder_organization.md' + - 'Auto save and reload': 'features/quick_save.md' + - 'Instant action': 'features/instant_action.md' + - Tutorials: + - Software: + - 'Add new roms': 'tutorials/software/add_roms.md' + - 'Add opk files': 'tutorials/software/copy_opk.md' + - 'Install the GBA/PS1 BIOS': 'tutorials/software/gba_bios.md' + - 'Change aspect ratio': 'tutorials/software/aspect_ratio.md' + - 'Take a snapshot': 'tutorials/software/snapshot.md' + - 'Firmware upgrade': 'tutorials/software/update.md' + - 'Create themes': 'tutorials/software/themes.md' + - 'Restore default games & emulators': 'tutorials/software/restore_games.md' + - Hardware: + - 'Open/close the console': 'tutorials/hardware/open_console.md' + - 'Flash & change the SD card': 'tutorials/hardware/change_sd_card.md' + - 'Change the buttons': 'tutorials/hardware/buttons.md' + - 'Force shutdown': 'tutorials/hardware/force_shutdown.md' - Developer's Guide: - - Hardware: - - 'Design' : 'developers/hardware/design.md' - - 'Architecture': 'developers/hardware/architecture.md' + - Hardware reference: + - 'Design' : 'developers/hardware_ref/design.md' + - 'Architecture': 'developers/hardware_ref/architecture.md' - 'BOM': 'https://htmlpreview.github.io/?https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/BOM/ibom.html' - - 'CPU': 'developers/hardware/cpu.md' - - 'Power': - - 'Regulated DC Power Supply Topologies': 'developers/hardware/power/dc-dc.md' - - 'Why so many different Power Supply Voltages?': 'developers/hardware/power/voltages.md' - - 'PMIC': 'developers/hardware/power/pmic.md' - - 'DRAM Power': 'developers/hardware/power/dram.md' - - 'Decoupling' : 'developers/hardware/power/decoupling.md' - - 'Screen': 'developers/hardware/screen.md' - - 'Audio': 'developers/hardware/audio.md' - - 'Buttons': 'developers/hardware/buttons.md' - - 'SD Card': 'developers/hardware/sd-card.md' - - 'USB': 'developers/hardware/usb.md' - - 'UART': 'developers/hardware/uart.md' - - 'Magnetic Switch': 'developers/hardware/magnetic_switch.md' - - Software: - - 'System': - - 'Software Architecture': 'developers/software/system/architecture.md' - - 'Instant Action': - - 'Boot Process': 'developers/software/system/bootprocess.md' - - 'Bootloader': 'developers/software/system/bootloader.md' - - 'Kernel': 'developers/software/system/kernel.md' - - 'Init Scripts': 'developers/software/system/init.md' - - 'Shutdown Process': 'developers/software/system/shutdown.md' - - 'Storage': - - 'Partition Map': 'developers/software/system/partition.md' - - 'Built-in Recovery': 'developers/software/system/recovery.md' - - 'Root Filesystem': 'developers/software/system/rootfs.md' - - 'USB Shared Partition': 'developers/software/system/shared.md' - - 'Video Processing': 'developers/software/applications/video.md' - - 'User Input': 'developers/software/applications/input.md' - - 'Build System': 'developers/software/applications/build_system.md' - - 'Applications': - - 'Toolchain': 'developers/software/applications/toolchain.md' + - 'CPU': 'developers/hardware_ref/cpu.md' + - Power: + - 'Regulated DC Power Supply Topologies': 'developers/hardware_ref/power/dc-dc.md' + - 'Why so many different Power Supply Voltages?': 'developers/hardware_ref/power/voltages.md' + - 'PMIC': 'developers/hardware_ref/power/pmic.md' + - 'DRAM Power': 'developers/hardware_ref/power/dram.md' + - 'Decoupling' : 'developers/hardware_ref/power/decoupling.md' + - 'Screen': 'developers/hardware_ref/screen.md' + - 'Audio': 'developers/hardware_ref/audio.md' + - 'Buttons': 'developers/hardware_ref/buttons.md' + - 'SD Card': 'developers/hardware_ref/sd-card.md' + - 'USB': 'developers/hardware_ref/usb.md' + - 'UART': 'developers/hardware_ref/uart.md' + - 'Magnetic Switch': 'developers/hardware_ref/magnetic_switch.md' + - Software reference: + - 'Software Architecture': 'developers/software_ref/architecture.md' + - Boot process: + - 'Introduction': 'developers/software_ref/boot_process/boot_process_intro.md' + - 'Bootloader': 'developers/software_ref/boot_process/bootloader.md' + - 'Kernel': 'developers/software_ref/boot_process/kernel.md' + - 'Init Scripts': 'developers/software_ref/boot_process/init.md' + - 'Shutdown Process': 'developers/software_ref/boot_process/shutdown.md' + - Disk mapping: + - 'Introduction': 'developers/software_ref/disk_mapping/disk_mapping_intro.md' + - 'Partition Map': 'developers/software_ref/disk_mapping/partition.md' + - 'Built-in Recovery': 'developers/software_ref/disk_mapping/recovery.md' + - 'Root Filesystem': 'developers/software_ref/disk_mapping/rootfs.md' + - 'USB Shared Partition': 'developers/software_ref/disk_mapping/shared.md' + - 'Video Processing': 'developers/software_ref/video.md' + - 'Input mapping': 'developers/software_ref/input.md' + - Tutorials: + - 'Access the Recovery boot mode': 'developers/tutorials/recovery.md' + - 'SSH connection over USB': 'developers/tutorials/ssh_connection.md' + - 'Serial connection over UART': 'developers/tutorials/uart_connection.md' + - Build System: + - 'Introduction': 'developers/tutorials/build_system/build_system_intro.md' + - 'Compilation environments': 'developers/tutorials/build_system/compilation_environments.md' + - 'Compile SDK': 'developers/tutorials/build_system/toolchain.md' + - 'Compile distribution': 'developers/tutorials/build_system/build_system.md' + - 'Build programs using SDK': 'developers/tutorials/build_system/build_program_using_sdk.md' - Miscellaneous: - 'Glossary': 'miscellaneous/glossary.md' - 'FAQ': 'miscellaneous/faq.md'