diff --git a/docs/developers/hardware_ref/architecture.md b/docs/developers/hardware_reference/architecture.md similarity index 100% rename from docs/developers/hardware_ref/architecture.md rename to docs/developers/hardware_reference/architecture.md diff --git a/docs/developers/hardware_ref/audio.md b/docs/developers/hardware_reference/audio.md similarity index 100% rename from docs/developers/hardware_ref/audio.md rename to docs/developers/hardware_reference/audio.md diff --git a/docs/developers/hardware_ref/buttons.md b/docs/developers/hardware_reference/buttons.md similarity index 100% rename from docs/developers/hardware_ref/buttons.md rename to docs/developers/hardware_reference/buttons.md diff --git a/docs/developers/hardware_ref/cpu.md b/docs/developers/hardware_reference/cpu.md similarity index 100% rename from docs/developers/hardware_ref/cpu.md rename to docs/developers/hardware_reference/cpu.md diff --git a/docs/developers/hardware_ref/index.md b/docs/developers/hardware_reference/index.md similarity index 100% rename from docs/developers/hardware_ref/index.md rename to docs/developers/hardware_reference/index.md diff --git a/docs/developers/hardware_ref/magnetic_switch.md b/docs/developers/hardware_reference/magnetic_switch.md similarity index 100% rename from docs/developers/hardware_ref/magnetic_switch.md rename to docs/developers/hardware_reference/magnetic_switch.md diff --git a/docs/developers/hardware_ref/power/decoupling.md b/docs/developers/hardware_reference/power/decoupling.md similarity index 100% rename from docs/developers/hardware_ref/power/decoupling.md rename to docs/developers/hardware_reference/power/decoupling.md diff --git a/docs/developers/hardware_ref/power/dram.md b/docs/developers/hardware_reference/power/dram_power.md similarity index 100% rename from docs/developers/hardware_ref/power/dram.md rename to docs/developers/hardware_reference/power/dram_power.md diff --git a/docs/developers/hardware_ref/power/voltages.md b/docs/developers/hardware_reference/power/multiple_voltages.md similarity index 100% rename from docs/developers/hardware_ref/power/voltages.md rename to docs/developers/hardware_reference/power/multiple_voltages.md diff --git a/docs/developers/hardware_ref/power/pmic.md b/docs/developers/hardware_reference/power/pmic.md similarity index 100% rename from docs/developers/hardware_ref/power/pmic.md rename to docs/developers/hardware_reference/power/pmic.md diff --git a/docs/developers/hardware_ref/power/dc-dc.md b/docs/developers/hardware_reference/power/power_supplies_topologies.md similarity index 100% rename from docs/developers/hardware_ref/power/dc-dc.md rename to docs/developers/hardware_reference/power/power_supplies_topologies.md diff --git a/docs/developers/hardware_ref/screen.md b/docs/developers/hardware_reference/screen.md similarity index 100% rename from docs/developers/hardware_ref/screen.md rename to docs/developers/hardware_reference/screen.md diff --git a/docs/developers/hardware_ref/sd-card.md b/docs/developers/hardware_reference/sd-card.md similarity index 100% rename from docs/developers/hardware_ref/sd-card.md rename to docs/developers/hardware_reference/sd-card.md diff --git a/docs/developers/hardware_ref/uart.md b/docs/developers/hardware_reference/uart.md similarity index 100% rename from docs/developers/hardware_ref/uart.md rename to docs/developers/hardware_reference/uart.md diff --git a/docs/developers/hardware_ref/usb.md b/docs/developers/hardware_reference/usb.md similarity index 100% rename from docs/developers/hardware_ref/usb.md rename to docs/developers/hardware_reference/usb.md diff --git a/docs/developers/software_ref/boot_process/bootloader.md b/docs/developers/software_reference/boot_process/bootloader.md similarity index 100% rename from docs/developers/software_ref/boot_process/bootloader.md rename to docs/developers/software_reference/boot_process/bootloader.md diff --git a/docs/developers/software_ref/boot_process/boot_process_intro.md b/docs/developers/software_reference/boot_process/index.md similarity index 100% rename from docs/developers/software_ref/boot_process/boot_process_intro.md rename to docs/developers/software_reference/boot_process/index.md diff --git a/docs/developers/software_ref/boot_process/init.md b/docs/developers/software_reference/boot_process/init_scripts.md similarity index 100% rename from docs/developers/software_ref/boot_process/init.md rename to docs/developers/software_reference/boot_process/init_scripts.md diff --git a/docs/developers/software_ref/boot_process/kernel.md b/docs/developers/software_reference/boot_process/kernel.md similarity index 100% rename from docs/developers/software_ref/boot_process/kernel.md rename to docs/developers/software_reference/boot_process/kernel.md diff --git a/docs/developers/software_ref/boot_process/shutdown.md b/docs/developers/software_reference/boot_process/shutdown_process.md similarity index 100% rename from docs/developers/software_ref/boot_process/shutdown.md rename to docs/developers/software_reference/boot_process/shutdown_process.md diff --git a/docs/developers/software_ref/disk_mapping/disk_mapping_intro.md b/docs/developers/software_reference/disk_mapping/index.md similarity index 100% rename from docs/developers/software_ref/disk_mapping/disk_mapping_intro.md rename to docs/developers/software_reference/disk_mapping/index.md diff --git a/docs/developers/software_ref/disk_mapping/partition.md b/docs/developers/software_reference/disk_mapping/partition_map.md similarity index 100% rename from docs/developers/software_ref/disk_mapping/partition.md rename to docs/developers/software_reference/disk_mapping/partition_map.md diff --git a/docs/developers/software_ref/disk_mapping/recovery.md b/docs/developers/software_reference/disk_mapping/recovery.md similarity index 100% rename from docs/developers/software_ref/disk_mapping/recovery.md rename to docs/developers/software_reference/disk_mapping/recovery.md diff --git a/docs/developers/software_ref/disk_mapping/rootfs.md b/docs/developers/software_reference/disk_mapping/root_filesystem.md similarity index 100% rename from docs/developers/software_ref/disk_mapping/rootfs.md rename to docs/developers/software_reference/disk_mapping/root_filesystem.md diff --git a/docs/developers/software_ref/disk_mapping/shared.md b/docs/developers/software_reference/disk_mapping/usb_shared_partition.md similarity index 100% rename from docs/developers/software_ref/disk_mapping/shared.md rename to docs/developers/software_reference/disk_mapping/usb_shared_partition.md diff --git a/docs/developers/software_ref/index.md b/docs/developers/software_reference/index.md similarity index 91% rename from docs/developers/software_ref/index.md rename to docs/developers/software_reference/index.md index 813387b..6c0c07c 100644 --- a/docs/developers/software_ref/index.md +++ b/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) -section. +detailed in the [Boot Process][1] 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 -Partition](disk_mapping/partition.md) section. +The MicroSD card format is detailed in the [Disk Partition][2] +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<-- diff --git a/docs/developers/software_ref/input.md b/docs/developers/software_reference/input_mapping.md similarity index 100% rename from docs/developers/software_ref/input.md rename to docs/developers/software_reference/input_mapping.md diff --git a/docs/developers/software_ref/video.md b/docs/developers/software_reference/video_processing.md similarity index 100% rename from docs/developers/software_ref/video.md rename to docs/developers/software_reference/video_processing.md diff --git a/docs/developers/tutorials/build_system/build_system.md b/docs/developers/tutorials/access_recovery.md similarity index 100% rename from docs/developers/tutorials/build_system/build_system.md rename to docs/developers/tutorials/access_recovery.md diff --git a/docs/developers/tutorials/recovery.md b/docs/developers/tutorials/build_system/compile_distribution.md similarity index 100% rename from docs/developers/tutorials/recovery.md rename to docs/developers/tutorials/build_system/compile_distribution.md diff --git a/docs/developers/tutorials/build_system/build_system_intro.md b/docs/developers/tutorials/build_system/compile_sdk.md similarity index 100% rename from docs/developers/tutorials/build_system/build_system_intro.md rename to docs/developers/tutorials/build_system/compile_sdk.md diff --git a/docs/developers/tutorials/build_system/toolchain.md b/docs/developers/tutorials/build_system/index.md similarity index 100% rename from docs/developers/tutorials/build_system/toolchain.md rename to docs/developers/tutorials/build_system/index.md diff --git a/docs/index.md b/docs/index.md index a856f3b..b554e54 100644 --- a/docs/index.md +++ b/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 -[3]: developers/hardware_ref/ -[4]: developers/software_ref/disk_mapping/recovery.md +[2]: tutorials/software/firmware_update.md +[3]: developers/hardware_reference/ +[4]: developers/software_reference/disk_mapping/recovery.md [5]: miscellaneous/glossary.md [6]: miscellaneous/faq.md diff --git a/docs/tutorials/hardware/buttons.md b/docs/tutorials/hardware/change_buttons.md similarity index 100% rename from docs/tutorials/hardware/buttons.md rename to docs/tutorials/hardware/change_buttons.md diff --git a/docs/tutorials/hardware/change_sd_card.md b/docs/tutorials/hardware/flash_change_sd_card.md similarity index 100% rename from docs/tutorials/hardware/change_sd_card.md rename to docs/tutorials/hardware/flash_change_sd_card.md diff --git a/docs/tutorials/hardware/disassembling_console.md b/docs/tutorials/hardware/teardown.md similarity index 100% rename from docs/tutorials/hardware/disassembling_console.md rename to docs/tutorials/hardware/teardown.md diff --git a/docs/tutorials/software/copy_opk.md b/docs/tutorials/software/add_opk.md similarity index 100% rename from docs/tutorials/software/copy_opk.md rename to docs/tutorials/software/add_opk.md diff --git a/docs/tutorials/software/themes.md b/docs/tutorials/software/create_themes.md similarity index 100% rename from docs/tutorials/software/themes.md rename to docs/tutorials/software/create_themes.md diff --git a/docs/tutorials/software/update.md b/docs/tutorials/software/firmware_update.md similarity index 100% rename from docs/tutorials/software/update.md rename to docs/tutorials/software/firmware_update.md diff --git a/mkdocs.yml b/mkdocs.yml index 4172c19..8d20e0a 100644 --- a/mkdocs.yml +++ b/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: - - 'Key mapping': 'features/key_mapping.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' - - 'Auto save and reload': 'features/quick_save.md' - - 'Instant action': 'features/instant_action.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' - Tutorials: - Software: - - 'Add new ROMs': 'tutorials/software/add_roms.md' - - 'Add OPK files': 'tutorials/software/copy_opk.md' + - '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/update.md' - - 'Change Gameboy palette': 'tutorials/software/gb_palette.md' - # - 'Create themes': 'tutorials/software/themes.md' - #- 'Restore default games & emulators': 'tutorials/software/restore_games.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' - Hardware: - - 'Teardown': 'tutorials/hardware/disassembling_console.md' - - 'Flash & Switch micro-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 reference: - - 'developers/hardware_ref/index.md' - - 'Architecture': 'developers/hardware_ref/architecture.md' + - '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' + - "Developer's Guide": + - Hardware Reference: + - 'developers/hardware_reference/index.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' - - '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: - - 'developers/software_ref/index.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' + - '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' + - Software Reference: + - 'developers/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' + - Disk Mapping: + - 'developers/software_reference/disk_mapping/index.md' + - 'Partition Map': 'developers/software_reference/disk_mapping/partition_map.md' + - 'Recovery': 'developers/software_reference/disk_mapping/recovery.md' + - 'Root Filesystem': 'developers/software_reference/disk_mapping/root_filesystem.md' + - 'USB Shared Partition': 'developers/software_reference/disk_mapping/usb_shared_partition.md' + - 'Video Processing': 'developers/software_reference/video_processing.md' + - 'Input Mapping': 'developers/software_reference/input_mapping.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' + - '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' - 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' + - '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' - Miscellaneous: - 'Glossary': 'miscellaneous/glossary.md' - 'FAQ': 'miscellaneous/faq.md'