From a01eba417fab94b5c417e4f65c2e1a9a8aa7c09a Mon Sep 17 00:00:00 2001 From: Michel-FK Date: Tue, 2 Feb 2021 08:19:21 +0100 Subject: [PATCH] change directory structure to match index Signed-off-by: Michel-FK --- .github/workflows/ci.yml | 1 + .../hardware_reference/architecture.md | 0 .../hardware_reference/audio.md | 0 .../hardware_reference/buttons.md | 0 .../hardware_reference/cpu.md | 0 .../hardware_reference/index.md | 0 .../hardware_reference/magnetic_switch.md | 0 .../hardware_reference/power/decoupling.md | 0 .../hardware_reference/power/dram_power.md | 0 .../power/multiple_voltages.md | 0 .../hardware_reference/power/pmic.md | 0 .../power/power_supplies_topologies.md | 0 .../hardware_reference/screen.md | 0 .../hardware_reference/sd-card.md | 0 .../hardware_reference/uart.md | 0 .../hardware_reference/usb.md | 0 .../boot_process/bootloader.md | 0 .../software_reference/boot_process/index.md | 0 .../boot_process/init_scripts.md | 0 .../software_reference/boot_process/kernel.md | 0 .../boot_process/shutdown_process.md | 0 .../software_reference/index.md | 0 .../software_reference/input_mapping.md | 0 .../sd_card_layout/index.md | 0 .../sd_card_layout/partition_map.md | 0 .../sd_card_layout/recovery_partition.md | 0 .../root_filesystem_partition.md | 0 .../sd_card_layout/usb_shared_partition.md | 0 .../software_reference/video_processing.md | 0 .../tutorials/access_recovery.md | 0 .../build_system/build_program_using_sdk.md | 0 .../build_system/compilation_environments.md | 0 .../build_system/compile_distribution.md | 0 .../tutorials/build_system/compile_sdk.md | 0 .../tutorials/build_system/index.md | 0 .../tutorials/ssh_connection.md | 0 .../tutorials/uart_connection.md | 0 docs/index.md | 8 +- docs/{ => user_manual}/features/emulators.md | 0 .../features/folder_organization.md | 0 .../{ => user_manual}/features/funkey_menu.md | 0 docs/{ => user_manual}/features/games_apps.md | 0 .../features/instant_action.md | 0 .../{ => user_manual}/features/key_mapping.md | 0 docs/{ => user_manual}/features/launchers.md | 0 docs/{ => user_manual}/features/quick_save.md | 0 docs/{ => user_manual}/quickstart.md | 0 .../tutorials/hardware/change_buttons.md | 0 .../hardware/flash_change_sd_card.md | 0 .../tutorials/hardware/force_shutdown.md | 0 .../tutorials/hardware/teardown.md | 0 .../tutorials/software/add_opk.md | 0 .../tutorials/software/add_roms.md | 0 .../tutorials/software/aspect_ratio.md | 0 .../tutorials/software/create_themes.md | 0 .../tutorials/software/firmware_update.md | 0 .../tutorials/software/gb_palette.md | 0 .../tutorials/software/gba_bios.md | 0 .../tutorials/software/restore_games.md | 0 .../tutorials/software/snapshot.md | 0 mkdocs.yml | 127 +++++++++--------- 61 files changed, 71 insertions(+), 65 deletions(-) rename docs/{developers => developer_guide}/hardware_reference/architecture.md (100%) rename docs/{developers => developer_guide}/hardware_reference/audio.md (100%) rename docs/{developers => developer_guide}/hardware_reference/buttons.md (100%) rename docs/{developers => developer_guide}/hardware_reference/cpu.md (100%) rename docs/{developers => developer_guide}/hardware_reference/index.md (100%) rename docs/{developers => developer_guide}/hardware_reference/magnetic_switch.md (100%) rename docs/{developers => developer_guide}/hardware_reference/power/decoupling.md (100%) rename docs/{developers => developer_guide}/hardware_reference/power/dram_power.md (100%) rename docs/{developers => developer_guide}/hardware_reference/power/multiple_voltages.md (100%) rename docs/{developers => developer_guide}/hardware_reference/power/pmic.md (100%) rename docs/{developers => developer_guide}/hardware_reference/power/power_supplies_topologies.md (100%) rename docs/{developers => developer_guide}/hardware_reference/screen.md (100%) rename docs/{developers => developer_guide}/hardware_reference/sd-card.md (100%) rename docs/{developers => developer_guide}/hardware_reference/uart.md (100%) rename docs/{developers => developer_guide}/hardware_reference/usb.md (100%) rename docs/{developers => developer_guide}/software_reference/boot_process/bootloader.md (100%) rename docs/{developers => developer_guide}/software_reference/boot_process/index.md (100%) rename docs/{developers => developer_guide}/software_reference/boot_process/init_scripts.md (100%) rename docs/{developers => developer_guide}/software_reference/boot_process/kernel.md (100%) rename docs/{developers => developer_guide}/software_reference/boot_process/shutdown_process.md (100%) rename docs/{developers => developer_guide}/software_reference/index.md (100%) rename docs/{developers => developer_guide}/software_reference/input_mapping.md (100%) rename docs/{developers => developer_guide}/software_reference/sd_card_layout/index.md (100%) rename docs/{developers => developer_guide}/software_reference/sd_card_layout/partition_map.md (100%) rename docs/{developers => developer_guide}/software_reference/sd_card_layout/recovery_partition.md (100%) rename docs/{developers => developer_guide}/software_reference/sd_card_layout/root_filesystem_partition.md (100%) rename docs/{developers => developer_guide}/software_reference/sd_card_layout/usb_shared_partition.md (100%) rename docs/{developers => developer_guide}/software_reference/video_processing.md (100%) rename docs/{developers => developer_guide}/tutorials/access_recovery.md (100%) rename docs/{developers => developer_guide}/tutorials/build_system/build_program_using_sdk.md (100%) rename docs/{developers => developer_guide}/tutorials/build_system/compilation_environments.md (100%) rename docs/{developers => developer_guide}/tutorials/build_system/compile_distribution.md (100%) rename docs/{developers => developer_guide}/tutorials/build_system/compile_sdk.md (100%) rename docs/{developers => developer_guide}/tutorials/build_system/index.md (100%) rename docs/{developers => developer_guide}/tutorials/ssh_connection.md (100%) rename docs/{developers => developer_guide}/tutorials/uart_connection.md (100%) rename docs/{ => user_manual}/features/emulators.md (100%) rename docs/{ => user_manual}/features/folder_organization.md (100%) rename docs/{ => user_manual}/features/funkey_menu.md (100%) rename docs/{ => user_manual}/features/games_apps.md (100%) rename docs/{ => user_manual}/features/instant_action.md (100%) rename docs/{ => user_manual}/features/key_mapping.md (100%) rename docs/{ => user_manual}/features/launchers.md (100%) rename docs/{ => user_manual}/features/quick_save.md (100%) rename docs/{ => user_manual}/quickstart.md (100%) rename docs/{ => user_manual}/tutorials/hardware/change_buttons.md (100%) rename docs/{ => user_manual}/tutorials/hardware/flash_change_sd_card.md (100%) rename docs/{ => user_manual}/tutorials/hardware/force_shutdown.md (100%) rename docs/{ => user_manual}/tutorials/hardware/teardown.md (100%) rename docs/{ => user_manual}/tutorials/software/add_opk.md (100%) rename docs/{ => user_manual}/tutorials/software/add_roms.md (100%) rename docs/{ => user_manual}/tutorials/software/aspect_ratio.md (100%) rename docs/{ => user_manual}/tutorials/software/create_themes.md (100%) rename docs/{ => user_manual}/tutorials/software/firmware_update.md (100%) rename docs/{ => user_manual}/tutorials/software/gb_palette.md (100%) rename docs/{ => user_manual}/tutorials/software/gba_bios.md (100%) rename docs/{ => user_manual}/tutorials/software/restore_games.md (100%) rename docs/{ => user_manual}/tutorials/software/snapshot.md (100%) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b3e5327..815ac82 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,4 +15,5 @@ jobs: - run: pip install mkdocs-minify-plugin - run: pip install mkdocs-section-index - run: pip install mkdocs-exclude + - run: pip install mkdocs-redirects - run: mkdocs gh-deploy --force --remote-branch master diff --git a/docs/developers/hardware_reference/architecture.md b/docs/developer_guide/hardware_reference/architecture.md similarity index 100% rename from docs/developers/hardware_reference/architecture.md rename to docs/developer_guide/hardware_reference/architecture.md diff --git a/docs/developers/hardware_reference/audio.md b/docs/developer_guide/hardware_reference/audio.md similarity index 100% rename from docs/developers/hardware_reference/audio.md rename to docs/developer_guide/hardware_reference/audio.md diff --git a/docs/developers/hardware_reference/buttons.md b/docs/developer_guide/hardware_reference/buttons.md similarity index 100% rename from docs/developers/hardware_reference/buttons.md rename to docs/developer_guide/hardware_reference/buttons.md diff --git a/docs/developers/hardware_reference/cpu.md b/docs/developer_guide/hardware_reference/cpu.md similarity index 100% rename from docs/developers/hardware_reference/cpu.md rename to docs/developer_guide/hardware_reference/cpu.md diff --git a/docs/developers/hardware_reference/index.md b/docs/developer_guide/hardware_reference/index.md similarity index 100% rename from docs/developers/hardware_reference/index.md rename to docs/developer_guide/hardware_reference/index.md diff --git a/docs/developers/hardware_reference/magnetic_switch.md b/docs/developer_guide/hardware_reference/magnetic_switch.md similarity index 100% rename from docs/developers/hardware_reference/magnetic_switch.md rename to docs/developer_guide/hardware_reference/magnetic_switch.md diff --git a/docs/developers/hardware_reference/power/decoupling.md b/docs/developer_guide/hardware_reference/power/decoupling.md similarity index 100% rename from docs/developers/hardware_reference/power/decoupling.md rename to docs/developer_guide/hardware_reference/power/decoupling.md diff --git a/docs/developers/hardware_reference/power/dram_power.md b/docs/developer_guide/hardware_reference/power/dram_power.md similarity index 100% rename from docs/developers/hardware_reference/power/dram_power.md rename to docs/developer_guide/hardware_reference/power/dram_power.md diff --git a/docs/developers/hardware_reference/power/multiple_voltages.md b/docs/developer_guide/hardware_reference/power/multiple_voltages.md similarity index 100% rename from docs/developers/hardware_reference/power/multiple_voltages.md rename to docs/developer_guide/hardware_reference/power/multiple_voltages.md diff --git a/docs/developers/hardware_reference/power/pmic.md b/docs/developer_guide/hardware_reference/power/pmic.md similarity index 100% rename from docs/developers/hardware_reference/power/pmic.md rename to docs/developer_guide/hardware_reference/power/pmic.md diff --git a/docs/developers/hardware_reference/power/power_supplies_topologies.md b/docs/developer_guide/hardware_reference/power/power_supplies_topologies.md similarity index 100% rename from docs/developers/hardware_reference/power/power_supplies_topologies.md rename to docs/developer_guide/hardware_reference/power/power_supplies_topologies.md diff --git a/docs/developers/hardware_reference/screen.md b/docs/developer_guide/hardware_reference/screen.md similarity index 100% rename from docs/developers/hardware_reference/screen.md rename to docs/developer_guide/hardware_reference/screen.md diff --git a/docs/developers/hardware_reference/sd-card.md b/docs/developer_guide/hardware_reference/sd-card.md similarity index 100% rename from docs/developers/hardware_reference/sd-card.md rename to docs/developer_guide/hardware_reference/sd-card.md diff --git a/docs/developers/hardware_reference/uart.md b/docs/developer_guide/hardware_reference/uart.md similarity index 100% rename from docs/developers/hardware_reference/uart.md rename to docs/developer_guide/hardware_reference/uart.md diff --git a/docs/developers/hardware_reference/usb.md b/docs/developer_guide/hardware_reference/usb.md similarity index 100% rename from docs/developers/hardware_reference/usb.md rename to docs/developer_guide/hardware_reference/usb.md diff --git a/docs/developers/software_reference/boot_process/bootloader.md b/docs/developer_guide/software_reference/boot_process/bootloader.md similarity index 100% rename from docs/developers/software_reference/boot_process/bootloader.md rename to docs/developer_guide/software_reference/boot_process/bootloader.md diff --git a/docs/developers/software_reference/boot_process/index.md b/docs/developer_guide/software_reference/boot_process/index.md similarity index 100% rename from docs/developers/software_reference/boot_process/index.md rename to docs/developer_guide/software_reference/boot_process/index.md diff --git a/docs/developers/software_reference/boot_process/init_scripts.md b/docs/developer_guide/software_reference/boot_process/init_scripts.md similarity index 100% rename from docs/developers/software_reference/boot_process/init_scripts.md rename to docs/developer_guide/software_reference/boot_process/init_scripts.md diff --git a/docs/developers/software_reference/boot_process/kernel.md b/docs/developer_guide/software_reference/boot_process/kernel.md similarity index 100% rename from docs/developers/software_reference/boot_process/kernel.md rename to docs/developer_guide/software_reference/boot_process/kernel.md diff --git a/docs/developers/software_reference/boot_process/shutdown_process.md b/docs/developer_guide/software_reference/boot_process/shutdown_process.md similarity index 100% rename from docs/developers/software_reference/boot_process/shutdown_process.md rename to docs/developer_guide/software_reference/boot_process/shutdown_process.md diff --git a/docs/developers/software_reference/index.md b/docs/developer_guide/software_reference/index.md similarity index 100% rename from docs/developers/software_reference/index.md rename to docs/developer_guide/software_reference/index.md diff --git a/docs/developers/software_reference/input_mapping.md b/docs/developer_guide/software_reference/input_mapping.md similarity index 100% rename from docs/developers/software_reference/input_mapping.md rename to docs/developer_guide/software_reference/input_mapping.md diff --git a/docs/developers/software_reference/sd_card_layout/index.md b/docs/developer_guide/software_reference/sd_card_layout/index.md similarity index 100% rename from docs/developers/software_reference/sd_card_layout/index.md rename to docs/developer_guide/software_reference/sd_card_layout/index.md diff --git a/docs/developers/software_reference/sd_card_layout/partition_map.md b/docs/developer_guide/software_reference/sd_card_layout/partition_map.md similarity index 100% rename from docs/developers/software_reference/sd_card_layout/partition_map.md rename to docs/developer_guide/software_reference/sd_card_layout/partition_map.md diff --git a/docs/developers/software_reference/sd_card_layout/recovery_partition.md b/docs/developer_guide/software_reference/sd_card_layout/recovery_partition.md similarity index 100% rename from docs/developers/software_reference/sd_card_layout/recovery_partition.md rename to docs/developer_guide/software_reference/sd_card_layout/recovery_partition.md diff --git a/docs/developers/software_reference/sd_card_layout/root_filesystem_partition.md b/docs/developer_guide/software_reference/sd_card_layout/root_filesystem_partition.md similarity index 100% rename from docs/developers/software_reference/sd_card_layout/root_filesystem_partition.md rename to docs/developer_guide/software_reference/sd_card_layout/root_filesystem_partition.md diff --git a/docs/developers/software_reference/sd_card_layout/usb_shared_partition.md b/docs/developer_guide/software_reference/sd_card_layout/usb_shared_partition.md similarity index 100% rename from docs/developers/software_reference/sd_card_layout/usb_shared_partition.md rename to docs/developer_guide/software_reference/sd_card_layout/usb_shared_partition.md diff --git a/docs/developers/software_reference/video_processing.md b/docs/developer_guide/software_reference/video_processing.md similarity index 100% rename from docs/developers/software_reference/video_processing.md rename to docs/developer_guide/software_reference/video_processing.md diff --git a/docs/developers/tutorials/access_recovery.md b/docs/developer_guide/tutorials/access_recovery.md similarity index 100% rename from docs/developers/tutorials/access_recovery.md rename to docs/developer_guide/tutorials/access_recovery.md diff --git a/docs/developers/tutorials/build_system/build_program_using_sdk.md b/docs/developer_guide/tutorials/build_system/build_program_using_sdk.md similarity index 100% rename from docs/developers/tutorials/build_system/build_program_using_sdk.md rename to docs/developer_guide/tutorials/build_system/build_program_using_sdk.md diff --git a/docs/developers/tutorials/build_system/compilation_environments.md b/docs/developer_guide/tutorials/build_system/compilation_environments.md similarity index 100% rename from docs/developers/tutorials/build_system/compilation_environments.md rename to docs/developer_guide/tutorials/build_system/compilation_environments.md diff --git a/docs/developers/tutorials/build_system/compile_distribution.md b/docs/developer_guide/tutorials/build_system/compile_distribution.md similarity index 100% rename from docs/developers/tutorials/build_system/compile_distribution.md rename to docs/developer_guide/tutorials/build_system/compile_distribution.md diff --git a/docs/developers/tutorials/build_system/compile_sdk.md b/docs/developer_guide/tutorials/build_system/compile_sdk.md similarity index 100% rename from docs/developers/tutorials/build_system/compile_sdk.md rename to docs/developer_guide/tutorials/build_system/compile_sdk.md diff --git a/docs/developers/tutorials/build_system/index.md b/docs/developer_guide/tutorials/build_system/index.md similarity index 100% rename from docs/developers/tutorials/build_system/index.md rename to docs/developer_guide/tutorials/build_system/index.md diff --git a/docs/developers/tutorials/ssh_connection.md b/docs/developer_guide/tutorials/ssh_connection.md similarity index 100% rename from docs/developers/tutorials/ssh_connection.md rename to docs/developer_guide/tutorials/ssh_connection.md diff --git a/docs/developers/tutorials/uart_connection.md b/docs/developer_guide/tutorials/uart_connection.md similarity index 100% rename from docs/developers/tutorials/uart_connection.md rename to docs/developer_guide/tutorials/uart_connection.md diff --git a/docs/index.md b/docs/index.md index fb86e60..0b0a907 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,10 +35,10 @@ For developers, a full [Developer's Guide][3] is included, with both 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/firmware_update.md -[3]: developers/hardware_reference/ -[4]: developers/software_reference/sd_card_layout/recovery_partition.md +[1]: user_manual/quickstart.md +[2]: user_manual/tutorials/software/firmware_update.md +[3]: developer_guide/hardware_reference/ +[4]: developer_guide/software_reference/sd_card_layout/recovery_partition.md [e5]: miscellaneous/glossary.md [6]: miscellaneous/faq.md diff --git a/docs/features/emulators.md b/docs/user_manual/features/emulators.md similarity index 100% rename from docs/features/emulators.md rename to docs/user_manual/features/emulators.md diff --git a/docs/features/folder_organization.md b/docs/user_manual/features/folder_organization.md similarity index 100% rename from docs/features/folder_organization.md rename to docs/user_manual/features/folder_organization.md diff --git a/docs/features/funkey_menu.md b/docs/user_manual/features/funkey_menu.md similarity index 100% rename from docs/features/funkey_menu.md rename to docs/user_manual/features/funkey_menu.md diff --git a/docs/features/games_apps.md b/docs/user_manual/features/games_apps.md similarity index 100% rename from docs/features/games_apps.md rename to docs/user_manual/features/games_apps.md diff --git a/docs/features/instant_action.md b/docs/user_manual/features/instant_action.md similarity index 100% rename from docs/features/instant_action.md rename to docs/user_manual/features/instant_action.md diff --git a/docs/features/key_mapping.md b/docs/user_manual/features/key_mapping.md similarity index 100% rename from docs/features/key_mapping.md rename to docs/user_manual/features/key_mapping.md diff --git a/docs/features/launchers.md b/docs/user_manual/features/launchers.md similarity index 100% rename from docs/features/launchers.md rename to docs/user_manual/features/launchers.md diff --git a/docs/features/quick_save.md b/docs/user_manual/features/quick_save.md similarity index 100% rename from docs/features/quick_save.md rename to docs/user_manual/features/quick_save.md diff --git a/docs/quickstart.md b/docs/user_manual/quickstart.md similarity index 100% rename from docs/quickstart.md rename to docs/user_manual/quickstart.md diff --git a/docs/tutorials/hardware/change_buttons.md b/docs/user_manual/tutorials/hardware/change_buttons.md similarity index 100% rename from docs/tutorials/hardware/change_buttons.md rename to docs/user_manual/tutorials/hardware/change_buttons.md diff --git a/docs/tutorials/hardware/flash_change_sd_card.md b/docs/user_manual/tutorials/hardware/flash_change_sd_card.md similarity index 100% rename from docs/tutorials/hardware/flash_change_sd_card.md rename to docs/user_manual/tutorials/hardware/flash_change_sd_card.md diff --git a/docs/tutorials/hardware/force_shutdown.md b/docs/user_manual/tutorials/hardware/force_shutdown.md similarity index 100% rename from docs/tutorials/hardware/force_shutdown.md rename to docs/user_manual/tutorials/hardware/force_shutdown.md diff --git a/docs/tutorials/hardware/teardown.md b/docs/user_manual/tutorials/hardware/teardown.md similarity index 100% rename from docs/tutorials/hardware/teardown.md rename to docs/user_manual/tutorials/hardware/teardown.md diff --git a/docs/tutorials/software/add_opk.md b/docs/user_manual/tutorials/software/add_opk.md similarity index 100% rename from docs/tutorials/software/add_opk.md rename to docs/user_manual/tutorials/software/add_opk.md diff --git a/docs/tutorials/software/add_roms.md b/docs/user_manual/tutorials/software/add_roms.md similarity index 100% rename from docs/tutorials/software/add_roms.md rename to docs/user_manual/tutorials/software/add_roms.md diff --git a/docs/tutorials/software/aspect_ratio.md b/docs/user_manual/tutorials/software/aspect_ratio.md similarity index 100% rename from docs/tutorials/software/aspect_ratio.md rename to docs/user_manual/tutorials/software/aspect_ratio.md diff --git a/docs/tutorials/software/create_themes.md b/docs/user_manual/tutorials/software/create_themes.md similarity index 100% rename from docs/tutorials/software/create_themes.md rename to docs/user_manual/tutorials/software/create_themes.md diff --git a/docs/tutorials/software/firmware_update.md b/docs/user_manual/tutorials/software/firmware_update.md similarity index 100% rename from docs/tutorials/software/firmware_update.md rename to docs/user_manual/tutorials/software/firmware_update.md diff --git a/docs/tutorials/software/gb_palette.md b/docs/user_manual/tutorials/software/gb_palette.md similarity index 100% rename from docs/tutorials/software/gb_palette.md rename to docs/user_manual/tutorials/software/gb_palette.md diff --git a/docs/tutorials/software/gba_bios.md b/docs/user_manual/tutorials/software/gba_bios.md similarity index 100% rename from docs/tutorials/software/gba_bios.md rename to docs/user_manual/tutorials/software/gba_bios.md diff --git a/docs/tutorials/software/restore_games.md b/docs/user_manual/tutorials/software/restore_games.md similarity index 100% rename from docs/tutorials/software/restore_games.md rename to docs/user_manual/tutorials/software/restore_games.md diff --git a/docs/tutorials/software/snapshot.md b/docs/user_manual/tutorials/software/snapshot.md similarity index 100% rename from docs/tutorials/software/snapshot.md rename to docs/user_manual/tutorials/software/snapshot.md diff --git a/mkdocs.yml b/mkdocs.yml index 1bd5520..9d57d1a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,9 +44,14 @@ plugins: minify_html: true - exclude: glob: - - tutorials/hardware/force_shutdown.md - - tutorials/software/restore_games.md - - tutorials/software/create_themes.md + - user_manual/tutorials/hardware/force_shutdown.md + - user_manual/tutorials/software/restore_games.md + - user_manual/tutorials/software/create_themes.md + - redirects: + redirect_maps: + 'tutorials/software/gb_palette.md' : 'user_manual/tutorials/software/gb_palette.md' + 'tutorials/software/gba_bios.md' : 'user_manual/tutorials/software/gba_bios.md' + 'developers/hardware_ref/buttons.md' : 'developer_guide/hardware_reference/buttons.md' # Customization extra: @@ -123,77 +128,77 @@ markdown_extensions: nav: - 'Overview': 'index.md' - "User's Manual": - - 'Quickstart': 'quickstart.md' + - 'Quickstart': 'user_manual/quickstart.md' - Product 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' - - 'Quick Save': 'features/quick_save.md' - - 'Instant Action': 'features/instant_action.md' + - 'Key Mapping': 'user_manual/features/key_mapping.md' + - 'Launchers': 'user_manual/features/launchers.md' + - 'Emulators': 'user_manual/features/emulators.md' + - 'Standalone Games & Applications': 'user_manual/features/games_apps.md' + - 'FunKey Menu': 'user_manual/features/funkey_menu.md' + - 'Folder Organization': 'user_manual/features/folder_organization.md' + - 'Quick Save': 'user_manual/features/quick_save.md' + - 'Instant Action': 'user_manual/features/instant_action.md' - Tutorials: - Software: - - 'Add New ROMs': 'tutorials/software/add_roms.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' - - 'Take a Snapshot': 'tutorials/software/snapshot.md' - - 'Firmware Upgrade': 'tutorials/software/firmware_update.md' - - 'Change Gameboy Palette': 'tutorials/software/gb_palette.md' - # - 'Create Themes': 'tutorials/software/create_themes.md' - #- 'Restore Default Games & Emulators': 'tutorials/software/restore_games.md' + - 'Add New ROMs': 'user_manual/tutorials/software/add_roms.md' + - 'Add OPK Files': 'user_manual/tutorials/software/add_opk.md' + - 'Install the GBA/PS1 BIOS': 'user_manual/tutorials/software/gba_bios.md' + - 'Change Aspect Ratio': 'user_manual/tutorials/software/aspect_ratio.md' + - 'Take a Snapshot': 'user_manual/tutorials/software/snapshot.md' + - 'Firmware Upgrade': 'user_manual/tutorials/software/firmware_update.md' + - 'Change Gameboy Palette': 'user_manual/tutorials/software/gb_palette.md' + # - 'Create Themes': 'user_manual/tutorials/software/create_themes.md' + #- 'Restore Default Games & Emulators': 'user_manual/tutorials/software/restore_games.md' - Hardware: - - 'Teardown': 'tutorials/hardware/teardown.md' - - 'Flash & Change micro-SD Card': 'tutorials/hardware/flash_change_sd_card.md' - - 'Change the Buttons': 'tutorials/hardware/change_buttons.md' - # - 'Force Shutdown': 'tutorials/hardware/force_shutdown.md' + - 'Teardown': 'user_manual/tutorials/hardware/teardown.md' + - 'Flash & Change micro-SD Card': 'user_manual/tutorials/hardware/flash_change_sd_card.md' + - 'Change the Buttons': 'user_manual/tutorials/hardware/change_buttons.md' + # - 'Force Shutdown': 'user_manual/tutorials/hardware/force_shutdown.md' - "Developer's Guide": - Hardware Reference: - - 'developers/hardware_reference/index.md' - - 'Architecture': 'developers/hardware_reference/architecture.md' + - 'developer_guide/hardware_reference/index.md' + - 'Architecture': 'developer_guide/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_reference/cpu.md' + - 'CPU': 'developer_guide/hardware_reference/cpu.md' - Power: - - 'Regulated DC Power Supply Topologies': 'developers/hardware_reference/power/power_supplies_topologies.md' - - 'Multiple Power Supply Voltages': 'developers/hardware_reference/power/multiple_voltages.md' - - 'PMIC': 'developers/hardware_reference/power/pmic.md' - - 'DRAM Power': 'developers/hardware_reference/power/dram_power.md' - - 'Decoupling' : 'developers/hardware_reference/power/decoupling.md' - - 'Screen': 'developers/hardware_reference/screen.md' - - 'Audio': 'developers/hardware_reference/audio.md' - - 'Buttons': 'developers/hardware_reference/buttons.md' - - 'SD Card': 'developers/hardware_reference/sd-card.md' - - 'USB': 'developers/hardware_reference/usb.md' - - 'UART': 'developers/hardware_reference/uart.md' - - 'Magnetic Switch': 'developers/hardware_reference/magnetic_switch.md' + - 'Regulated DC Power Supply Topologies': 'developer_guide/hardware_reference/power/power_supplies_topologies.md' + - 'Multiple Power Supply Voltages': 'developer_guide/hardware_reference/power/multiple_voltages.md' + - 'PMIC': 'developer_guide/hardware_reference/power/pmic.md' + - 'DRAM Power': 'developer_guide/hardware_reference/power/dram_power.md' + - 'Decoupling' : 'developer_guide/hardware_reference/power/decoupling.md' + - 'Screen': 'developer_guide/hardware_reference/screen.md' + - 'Audio': 'developer_guide/hardware_reference/audio.md' + - 'Buttons': 'developer_guide/hardware_reference/buttons.md' + - 'SD Card': 'developer_guide/hardware_reference/sd-card.md' + - 'USB': 'developer_guide/hardware_reference/usb.md' + - 'UART': 'developer_guide/hardware_reference/uart.md' + - 'Magnetic Switch': 'developer_guide/hardware_reference/magnetic_switch.md' - Software Reference: - - 'developers/software_reference/index.md' + - 'developer_guide/software_reference/index.md' - Boot Process: - - 'developers/software_reference/boot_process/index.md' - - 'Bootloader': 'developers/software_reference/boot_process/bootloader.md' - - 'Kernel': 'developers/software_reference/boot_process/kernel.md' - - 'Init Scripts': 'developers/software_reference/boot_process/init_scripts.md' - - 'Shutdown Process': 'developers/software_reference/boot_process/shutdown_process.md' + - 'developer_guide/software_reference/boot_process/index.md' + - 'Bootloader': 'developer_guide/software_reference/boot_process/bootloader.md' + - 'Kernel': 'developer_guide/software_reference/boot_process/kernel.md' + - 'Init Scripts': 'developer_guide/software_reference/boot_process/init_scripts.md' + - 'Shutdown Process': 'developer_guide/software_reference/boot_process/shutdown_process.md' - SD-Card Layout: - - 'developers/software_reference/sd_card_layout/index.md' - - 'Partition Map': 'developers/software_reference/sd_card_layout/partition_map.md' - - 'Recovery Partition': 'developers/software_reference/sd_card_layout/recovery_partition.md' - - 'Root Filesystem Partition': 'developers/software_reference/sd_card_layout/root_filesystem_partition.md' - - 'USB Shared Partition': 'developers/software_reference/sd_card_layout/usb_shared_partition.md' - - 'Video Processing': 'developers/software_reference/video_processing.md' - - 'Input Mapping': 'developers/software_reference/input_mapping.md' + - 'developer_guide/software_reference/sd_card_layout/index.md' + - 'Partition Map': 'developer_guide/software_reference/sd_card_layout/partition_map.md' + - 'Recovery Partition': 'developer_guide/software_reference/sd_card_layout/recovery_partition.md' + - 'Root Filesystem Partition': 'developer_guide/software_reference/sd_card_layout/root_filesystem_partition.md' + - 'USB Shared Partition': 'developer_guide/software_reference/sd_card_layout/usb_shared_partition.md' + - 'Video Processing': 'developer_guide/software_reference/video_processing.md' + - 'Input Mapping': 'developer_guide/software_reference/input_mapping.md' - Tutorials: - - 'Access the Recovery Boot Mode': 'developers/tutorials/access_recovery.md' - - 'SSH Connection over USB': 'developers/tutorials/ssh_connection.md' - - 'Serial Connection over UART': 'developers/tutorials/uart_connection.md' + - 'Access the Recovery Boot Mode': 'developer_guide/tutorials/access_recovery.md' + - 'SSH Connection over USB': 'developer_guide/tutorials/ssh_connection.md' + - 'Serial Connection over UART': 'developer_guide/tutorials/uart_connection.md' - Build System: - - 'developers/tutorials/build_system/index.md' - - 'Compilation Environments': 'developers/tutorials/build_system/compilation_environments.md' - - 'Compile SDK': 'developers/tutorials/build_system/compile_sdk.md' - - 'Compile Distribution': 'developers/tutorials/build_system/compile_distribution.md' - - 'Build Programs using SDK': 'developers/tutorials/build_system/build_program_using_sdk.md' + - 'developer_guide/tutorials/build_system/index.md' + - 'Compilation Environments': 'developer_guide/tutorials/build_system/compilation_environments.md' + - 'Compile SDK': 'developer_guide/tutorials/build_system/compile_sdk.md' + - 'Compile Distribution': 'developer_guide/tutorials/build_system/compile_distribution.md' + - 'Build Programs using SDK': 'developer_guide/tutorials/build_system/build_program_using_sdk.md' - Miscellaneous: - 'Glossary': 'miscellaneous/glossary.md' - 'FAQ': 'miscellaneous/faq.md'