aboutsummaryrefslogtreecommitdiffstats
path: root/docs/_summary.md
diff options
context:
space:
mode:
authorGravatar skullY <skullydazed@gmail.com>2020-02-20 11:06:27 -0800
committerGravatar skullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commitd1c18086d23c1f510ee434e1aa12b203f36e4794 (patch)
tree7d3560252ab9ed7ae8ed002b0b7a388813213493 /docs/_summary.md
parent4ef10a424ae1174bc108de9014dfd1f0ff6751e0 (diff)
downloadqmk_firmware-d1c18086d23c1f510ee434e1aa12b203f36e4794.tar.gz
wip
Diffstat (limited to 'docs/_summary.md')
-rw-r--r--docs/_summary.md157
1 files changed, 76 insertions, 81 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index a429138b8..66465667a 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -1,21 +1,23 @@
* [Complete Newbs Guide](newbs.md)
- * [Getting Started](newbs_getting_started.md)
+ * [Introduction](newbs_getting_started.md)
* [Building Your First Firmware](newbs_building_firmware.md)
* [Flashing Firmware](newbs_flashing.md)
* [Testing and Debugging](newbs_testing_debugging.md)
+ * [Getting Help](getting_started_getting_help.md)
+
+* Guides
+ * [ARM Debugging Guide](arm_debugging.md)
* [Best Git Practices](newbs_git_best_practices.md)
- * [Using Your Fork's Master](newbs_git_using_your_master_branch.md)
- * [Resolving Merge Conflicts](newbs_git_resolving_merge_conflicts.md)
- * [Resynchronizing a Branch](newbs_git_resynchronize_a_branch.md)
+ * [Contributing to QMK](contributing.md)
+ * [Customizing Functionality](custom_quantum_functions.md)
+ * [Github Best Practices](getting_started_github.md)
+ * [Hand Wiring Guide](hand_wire.md)
+ * [ISP Flashing Guide](isp_flashing_guide.md)
+ * [Flashing Firmware](flashing.md)
+ * [Keymap Overview](keymap.md)
* [Learning Resources](newbs_learn_more_resources.md)
-
-* [QMK Basics](README.md)
- * [QMK Introduction](getting_started_introduction.md)
* [QMK CLI](cli.md)
- * [QMK CLI Config](cli_configuration.md)
- * [Contributing to QMK](contributing.md)
- * [How to Use Github](getting_started_github.md)
- * [Getting Help](getting_started_getting_help.md)
+ * [Vagrant Guide](getting_started_vagrant.md)
* [Breaking Changes](breaking_changes.md)
* [My Pull Request Was Flagged](breaking_changes_instructions.md)
@@ -28,87 +30,80 @@
* [Keymap](faq_keymap.md)
* [Driver Installation with Zadig](driver_installation_zadig.md)
-* Detailed Guides
- * [Install Build Tools](getting_started_build_tools.md)
- * [Vagrant Guide](getting_started_vagrant.md)
- * [Build/Compile Instructions](getting_started_make_guide.md)
- * [Flashing Firmware](flashing.md)
- * [Customizing Functionality](custom_quantum_functions.md)
- * [Keymap Overview](keymap.md)
-
-* [Hardware](hardware.md)
- * [Compatible Microcontrollers](compatible_microcontrollers.md)
- * [AVR Processors](hardware_avr.md)
- * [Drivers](hardware_drivers.md)
+* QMK Features
+ * [Keycodes](keycodes.md)
+ * [Basic Keycodes](keycodes_basic.md)
+ * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
+ * [Quantum Keycodes](quantum_keycodes.md)
+ * [Advanced Keycodes](feature_advanced_keycodes.md)
+ * [Auto Shift](feature_auto_shift.md)
+ * Software Features
+ * [Combos](feature_combo.md)
+ * [Command](feature_command.md)
+ * [Debounce API](feature_debounce_type.md)
+ * [Dynamic Macros](feature_dynamic_macros.md)
+ * [Grave Escape](feature_grave_esc.md)
+ * [Key Lock](feature_key_lock.md)
+ * [Leader Key](feature_leader_key.md)
+ * [Macros](feature_macros.md)
+ * [Mouse Keys](feature_mouse_keys.md)
+ * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
+ * [Pointing Device](feature_pointing_device.md)
+ * [Space Cadet](feature_space_cadet.md)
+ * [Swap Hands](feature_swap_hands.md)
+ * [Tap Dance](feature_tap_dance.md)
+ * [Terminal](feature_terminal.md)
+ * [Unicode](feature_unicode.md)
+ * [Userspace](feature_userspace.md)
+ * Hardware Features
+ * [Audio](feature_audio.md)
+ * [Backlight](feature_backlight.md)
+ * [Bluetooth](feature_bluetooth.md)
+ * [Bootmagic](feature_bootmagic.md)
+ * [Custom Matrix](custom_matrix.md)
+ * [DIP Switch](feature_dip_switch.md)
+ * [Encoders](feature_encoders.md)
+ * [Haptic Feedback](feature_haptic_feedback.md)
+ * [HD44780 LCD Controller](feature_hd44780.md)
+ * [LED Matrix](feature_led_matrix.md)
+ * [OLED Driver](feature_oled_driver.md)
+ * [Proton C Conversion](proton_c_conversion.md)
+ * [PS/2 Mouse](feature_ps2_mouse.md)
+ * [RGB Lighting](feature_rgblight.md)
+ * [RGB Matrix](feature_rgb_matrix.md)
+ * [Split Keyboard](feature_split_keyboard.md)
+ * [Stenography](feature_stenography.md)
+ * [Thermal Printer](feature_thermal_printer.md)
+ * [Velocikey](feature_velocikey.md)
-* Reference
- * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
+* QMK Reference
* [Config Options](config_options.md)
- * [Keycodes](keycodes.md)
- * [Coding Conventions - C](coding_conventions_c.md)
- * [Coding Conventions - Python](coding_conventions_python.md)
+ * [Make Documentation](getting_started_make_guide.md)
* [Documentation Best Practices](documentation_best_practices.md)
* [Documentation Templates](documentation_templates.md)
* [Glossary](reference_glossary.md)
+ * [Community Layouts](feature_layouts.md)
* [Unit Testing](unit_testing.md)
* [Useful Functions](ref_functions.md)
* [Configurator Support](reference_configurator_support.md)
* [info.json Format](reference_info_json.md)
- * [Python CLI Development](cli_development.md)
-* [Features](features.md)
- * [Basic Keycodes](keycodes_basic.md)
- * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
- * [Quantum Keycodes](quantum_keycodes.md)
- * [Advanced Keycodes](feature_advanced_keycodes.md)
- * [Audio](feature_audio.md)
- * [Auto Shift](feature_auto_shift.md)
- * [Backlight](feature_backlight.md)
- * [Bluetooth](feature_bluetooth.md)
- * [Bootmagic](feature_bootmagic.md)
- * [Combos](feature_combo.md)
- * [Command](feature_command.md)
- * [Debounce API](feature_debounce_type.md)
- * [DIP Switch](feature_dip_switch.md)
- * [Dynamic Macros](feature_dynamic_macros.md)
- * [Encoders](feature_encoders.md)
- * [Grave Escape](feature_grave_esc.md)
- * [Haptic Feedback](feature_haptic_feedback.md)
- * [HD44780 LCD Controller](feature_hd44780.md)
- * [Key Lock](feature_key_lock.md)
- * [Layouts](feature_layouts.md)
- * [Leader Key](feature_leader_key.md)
- * [LED Matrix](feature_led_matrix.md)
- * [Macros](feature_macros.md)
- * [Mouse Keys](feature_mouse_keys.md)
- * [OLED Driver](feature_oled_driver.md)
- * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
- * [Pointing Device](feature_pointing_device.md)
- * [PS/2 Mouse](feature_ps2_mouse.md)
- * [RGB Lighting](feature_rgblight.md)
- * [RGB Matrix](feature_rgb_matrix.md)
- * [Space Cadet](feature_space_cadet.md)
- * [Split Keyboard](feature_split_keyboard.md)
- * [Stenography](feature_stenography.md)
- * [Swap Hands](feature_swap_hands.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)
- * [Velocikey](feature_velocikey.md)
-
-* For Makers and Modders
- * [Hand Wiring Guide](hand_wire.md)
- * [ISP Flashing Guide](isp_flashing_guide.md)
- * [ARM Debugging Guide](arm_debugging.md)
- * [ADC Driver](adc_driver.md)
- * [I2C Driver](i2c_driver.md)
- * [WS2812 Driver](ws2812_driver.md)
- * [EEPROM Driver](eeprom_driver.md)
+* C Development
+ * [AVR Processors](hardware_avr.md)
+ * [Coding Conventions](coding_conventions_c.md)
+ * [Compatible Microcontrollers](compatible_microcontrollers.md)
+ * [Drivers](hardware_drivers.md)
+ * [ADC Driver](adc_driver.md)
+ * [I2C Driver](i2c_driver.md)
+ * [WS2812 Driver](ws2812_driver.md)
+ * [EEPROM Driver](eeprom_driver.md)
* [GPIO Controls](internals_gpio_control.md)
- * [Custom Matrix](custom_matrix.md)
- * [Proton C Conversion](proton_c_conversion.md)
+ * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
+
+* Python Development
+ * [Coding Conventions](coding_conventions_python.md)
+ * [QMK CLI Config](cli_configuration.md)
+ * [Python CLI Development](cli_development.md)
* For a Deeper Understanding
* [How Keyboards Work](how_keyboards_work.md)