]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - docs/_summary.md
Restructure the hardware and feature docs to make things easier to find (#1888)
[qmk_firmware.git] / docs / _summary.md
index 55cfd2ab3d8b31fefc60a5760c46888f85da58ca..b433181a6066dc246ecbe103ca754d2eb88916d2 100644 (file)
   * [Debugging/Troubleshooting QMK](faq_debug.md)
   * [Keymap](faq_keymap.md)
 
+* [Hardware](hardware.md)
+  * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
+  * [AVR Processors](hardware_avr.md)
+  * ARM Processors (TBD)
+  * [Drivers](hardware_drivers.md)
+
 * [Features](features.md)
-  * [Layouts](feature_layouts.md)
-  * [Common Shortcuts](feature_common_shortcuts.md)
-  * [Userspace](feature_userspace.md)
+  * [Advanced Keycodes](feature_advanced_keycodes.md)
+  * [Audio](feature_audio.md)
   * [Backlight](feature_backlight.md)
   * [Bootmagic](feature_bootmagic.md)
-  * [Dynamic Macros](dynamic_macros.md)
-  * [Key Lock](key_lock.md)
+  * [Dynamic Macros](feature_dynamic_macros.md)
+  * [Key Lock](feature_key_lock.md)
+  * [Layouts](feature_layouts.md)
   * [Leader Key](feature_leader_key.md)
-  * [Macros](macros.md)
-  * [Mouse keys](mouse_keys.md)
+  * [Macros](feature_macros.md)
+  * [Mouse keys](feature_mouse_keys.md)
   * [Pointing Device](feature_pointing_device.md)
   * [PS2 Mouse](feature_ps2_mouse.md)
-  * [Space Cadet](space_cadet_shift.md)
-  * [Tap Dance](tap_dance.md)
-  * [Audio](feature_audio.md)
-  * [Thermal Printer](feature_thermal_printer.md)
-  * [Stenography](stenography.md)
-  * [Unicode](unicode.md)
+  * [Space Cadet](feature_space_cadet.md)
+  * [Stenography](feature_stenography.md)
+  * [Tap Dance](feature_tap_dance.md)
   * [Terminal](feature_terminal.md)
+  * [Thermal Printer](feature_thermal_printer.md)
+  * [Unicode](feature_unicode.md)
+  * [Userspace](feature_userspace.md)
 
 * Reference
+  * [Config Options](config_options.md)
+  * [Customizing Functionality](custom_quantum_functions.md)
+  * [Documentation Best Practices](documentation_best_practices.md)
+  * [Documentation Templates](documentation_templates.md)
   * [Glossary](glossary.md)
   * [Keymap overview](keymap.md)
   * [Keycodes](keycodes.md)
-    * [Basic](keycodes_basic.md)
-    * [Quantum](quantum_keycodes.md)
     * [Backlight](feature_backlight.md#backlight-keycodes)
+    * [Basic](keycodes_basic.md)
     * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
     * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
     * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers)
     * [Mod+Key](feature_common_shortcuts.md#modifier-keys)
     * [Mod Tap](feature_common_shortcuts.md#mod-tap)
     * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys)
-    * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes)
-    * [Stenography](stenography.md#keycode-reference)
+    * [Quantum](quantum_keycodes.md)
     * [RGB Light](feature_rgblight.md#rgblight-keycodes)
+    * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes)
+    * [Stenography](feature_stenography.md#keycode-reference)
     * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
     * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
-  * [The `config.h` File](config_options.md)
-  * [Customizing Functionality](custom_quantum_functions.md)
-  * [Documentation Best Practices](documentation_best_practices.md)
-  * [Documentation Templates](documentation_templates.md)
   * [Unit Testing](unit_testing.md)
 
 * For Makers and Modders
-  * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
   * [Hand Wiring Guide](hand_wiring.md)
   * [ISP flashing guide](isp_flashing_guide.md)
   * [Modding your keyboard](modding_your_keyboard.md)
-  * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md)
 
 * For a Deeper Understanding
   * [How Keyboards Work](how_keyboards_work.md)