diff options
author | skullydazed <skullydazed@users.noreply.github.com> | 2017-10-24 20:34:28 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-10-24 20:34:28 -0700 |
commit | 67cc5cebc0430d15169e2c649ea25112a31bfa31 (patch) | |
tree | f90f432a40b1d03ec7b9e68666c2444f2b2d0e79 /docs/_summary.md | |
parent | 8892c50336fe49fbd3524ed44f2139074dca5ba6 (diff) | |
download | qmk_firmware-67cc5cebc0430d15169e2c649ea25112a31bfa31.tar.gz qmk_firmware-67cc5cebc0430d15169e2c649ea25112a31bfa31.zip |
Restructure the hardware and feature docs to make things easier to find (#1888)
* fix #1313 by documenting more config.h options
* Clean up and organize documentation
Diffstat (limited to 'docs/_summary.md')
-rw-r--r-- | docs/_summary.md | 50 |
1 files changed, 27 insertions, 23 deletions
diff --git a/docs/_summary.md b/docs/_summary.md index 55cfd2ab3..b433181a6 100644 --- a/docs/_summary.md +++ b/docs/_summary.md | |||
@@ -12,57 +12,61 @@ | |||
12 | * [Debugging/Troubleshooting QMK](faq_debug.md) | 12 | * [Debugging/Troubleshooting QMK](faq_debug.md) |
13 | * [Keymap](faq_keymap.md) | 13 | * [Keymap](faq_keymap.md) |
14 | 14 | ||
15 | * [Hardware](hardware.md) | ||
16 | * [Keyboard Guidelines](hardware_keyboard_guidelines.md) | ||
17 | * [AVR Processors](hardware_avr.md) | ||
18 | * ARM Processors (TBD) | ||
19 | * [Drivers](hardware_drivers.md) | ||
20 | |||
15 | * [Features](features.md) | 21 | * [Features](features.md) |
16 | * [Layouts](feature_layouts.md) | 22 | * [Advanced Keycodes](feature_advanced_keycodes.md) |
17 | * [Common Shortcuts](feature_common_shortcuts.md) | 23 | * [Audio](feature_audio.md) |
18 | * [Userspace](feature_userspace.md) | ||
19 | * [Backlight](feature_backlight.md) | 24 | * [Backlight](feature_backlight.md) |
20 | * [Bootmagic](feature_bootmagic.md) | 25 | * [Bootmagic](feature_bootmagic.md) |
21 | * [Dynamic Macros](dynamic_macros.md) | 26 | * [Dynamic Macros](feature_dynamic_macros.md) |
22 | * [Key Lock](key_lock.md) | 27 | * [Key Lock](feature_key_lock.md) |
28 | * [Layouts](feature_layouts.md) | ||
23 | * [Leader Key](feature_leader_key.md) | 29 | * [Leader Key](feature_leader_key.md) |
24 | * [Macros](macros.md) | 30 | * [Macros](feature_macros.md) |
25 | * [Mouse keys](mouse_keys.md) | 31 | * [Mouse keys](feature_mouse_keys.md) |
26 | * [Pointing Device](feature_pointing_device.md) | 32 | * [Pointing Device](feature_pointing_device.md) |
27 | * [PS2 Mouse](feature_ps2_mouse.md) | 33 | * [PS2 Mouse](feature_ps2_mouse.md) |
28 | * [Space Cadet](space_cadet_shift.md) | 34 | * [Space Cadet](feature_space_cadet.md) |
29 | * [Tap Dance](tap_dance.md) | 35 | * [Stenography](feature_stenography.md) |
30 | * [Audio](feature_audio.md) | 36 | * [Tap Dance](feature_tap_dance.md) |
31 | * [Thermal Printer](feature_thermal_printer.md) | ||
32 | * [Stenography](stenography.md) | ||
33 | * [Unicode](unicode.md) | ||
34 | * [Terminal](feature_terminal.md) | 37 | * [Terminal](feature_terminal.md) |
38 | * [Thermal Printer](feature_thermal_printer.md) | ||
39 | * [Unicode](feature_unicode.md) | ||
40 | * [Userspace](feature_userspace.md) | ||
35 | 41 | ||
36 | * Reference | 42 | * Reference |
43 | * [Config Options](config_options.md) | ||
44 | * [Customizing Functionality](custom_quantum_functions.md) | ||
45 | * [Documentation Best Practices](documentation_best_practices.md) | ||
46 | * [Documentation Templates](documentation_templates.md) | ||
37 | * [Glossary](glossary.md) | 47 | * [Glossary](glossary.md) |
38 | * [Keymap overview](keymap.md) | 48 | * [Keymap overview](keymap.md) |
39 | * [Keycodes](keycodes.md) | 49 | * [Keycodes](keycodes.md) |
40 | * [Basic](keycodes_basic.md) | ||
41 | * [Quantum](quantum_keycodes.md) | ||
42 | * [Backlight](feature_backlight.md#backlight-keycodes) | 50 | * [Backlight](feature_backlight.md#backlight-keycodes) |
51 | * [Basic](keycodes_basic.md) | ||
43 | * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes) | 52 | * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes) |
44 | * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes) | 53 | * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes) |
45 | * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers) | 54 | * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers) |
46 | * [Mod+Key](feature_common_shortcuts.md#modifier-keys) | 55 | * [Mod+Key](feature_common_shortcuts.md#modifier-keys) |
47 | * [Mod Tap](feature_common_shortcuts.md#mod-tap) | 56 | * [Mod Tap](feature_common_shortcuts.md#mod-tap) |
48 | * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys) | 57 | * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys) |
49 | * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes) | 58 | * [Quantum](quantum_keycodes.md) |
50 | * [Stenography](stenography.md#keycode-reference) | ||
51 | * [RGB Light](feature_rgblight.md#rgblight-keycodes) | 59 | * [RGB Light](feature_rgblight.md#rgblight-keycodes) |
60 | * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes) | ||
61 | * [Stenography](feature_stenography.md#keycode-reference) | ||
52 | * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) | 62 | * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) |
53 | * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) | 63 | * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) |
54 | * [The `config.h` File](config_options.md) | ||
55 | * [Customizing Functionality](custom_quantum_functions.md) | ||
56 | * [Documentation Best Practices](documentation_best_practices.md) | ||
57 | * [Documentation Templates](documentation_templates.md) | ||
58 | * [Unit Testing](unit_testing.md) | 64 | * [Unit Testing](unit_testing.md) |
59 | 65 | ||
60 | * For Makers and Modders | 66 | * For Makers and Modders |
61 | * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) | ||
62 | * [Hand Wiring Guide](hand_wiring.md) | 67 | * [Hand Wiring Guide](hand_wiring.md) |
63 | * [ISP flashing guide](isp_flashing_guide.md) | 68 | * [ISP flashing guide](isp_flashing_guide.md) |
64 | * [Modding your keyboard](modding_your_keyboard.md) | 69 | * [Modding your keyboard](modding_your_keyboard.md) |
65 | * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md) | ||
66 | 70 | ||
67 | * For a Deeper Understanding | 71 | * For a Deeper Understanding |
68 | * [How Keyboards Work](how_keyboards_work.md) | 72 | * [How Keyboards Work](how_keyboards_work.md) |