mirror of
https://github.com/FunKey-Project/FunKey-Project.github.io.git
synced 2025-12-12 18:28:51 +01:00
new file architecture (with files added)
This commit is contained in:
parent
c9c720b76b
commit
cb7874fb12
@ -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
|
||||
|
||||
4
docs/developers/software_ref/boot_process/bootloader.md
Normal file
4
docs/developers/software_ref/boot_process/bootloader.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/developers/software_ref/boot_process/shutdown.md
Normal file
4
docs/developers/software_ref/boot_process/shutdown.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/developers/tutorials/build_system/build_system.md
Normal file
4
docs/developers/tutorials/build_system/build_system.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
@ -1,4 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/developers/tutorials/ssh_connection.md
Normal file
4
docs/developers/tutorials/ssh_connection.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/developers/tutorials/uart_connection.md
Normal file
4
docs/developers/tutorials/uart_connection.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/emulators.md
Normal file
4
docs/features/emulators.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/folder_organization.md
Normal file
4
docs/features/folder_organization.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/funkey_menu.md
Normal file
4
docs/features/funkey_menu.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/games_apps.md
Normal file
4
docs/features/games_apps.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/instant_action.md
Normal file
4
docs/features/instant_action.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/key_mapping.md
Normal file
4
docs/features/key_mapping.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/launchers.md
Normal file
4
docs/features/launchers.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/features/quick_save.md
Normal file
4
docs/features/quick_save.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
@ -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
|
||||
|
||||
|
||||
5
docs/tutorials/hardware/buttons.md
Normal file
5
docs/tutorials/hardware/buttons.md
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
|
||||
4
docs/tutorials/hardware/change_sd_card.md
Normal file
4
docs/tutorials/hardware/change_sd_card.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/tutorials/hardware/force_shutdown.md
Normal file
4
docs/tutorials/hardware/force_shutdown.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/tutorials/hardware/open_console.md
Normal file
4
docs/tutorials/hardware/open_console.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/tutorials/software/add_roms.md
Normal file
4
docs/tutorials/software/add_roms.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/tutorials/software/aspect_ratio.md
Normal file
4
docs/tutorials/software/aspect_ratio.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/tutorials/software/restore_games.md
Normal file
4
docs/tutorials/software/restore_games.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/tutorials/software/snapshot.md
Normal file
4
docs/tutorials/software/snapshot.md
Normal file
@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
114
mkdocs.yml
114
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'
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user