From d263b27c9a998e31084d7960724b3c243311c4cf Mon Sep 17 00:00:00 2001 From: fauxpark Date: Mon, 6 Aug 2018 13:08:26 +1000 Subject: Dedupe shifted keycodes listing --- docs/_sidebar.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 6c56bb2e51..69170d8bb1 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -68,11 +68,10 @@ * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) * [RGB Light](feature_rgblight.md#rgblight-keycodes) * [RGB Matrix](feature_rgb_matrix.md#keycodes) - * [Shifted Keys](feature_advanced_keycodes.md#shifted-keycodes) + * [Shifted Keys](keycodes_us_ansi_shifted.md) * [Stenography](feature_stenography.md#keycode-reference) * [Swap Hands](feature_swap_hands.md#swap-keycodes) * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) - * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) * Reference * [Config Options](config_options.md) -- cgit v1.2.3 From da24a34efbfdeb80190b78f3f59451af86c4fb8b Mon Sep 17 00:00:00 2001 From: skullY Date: Sat, 11 Aug 2018 14:54:27 -0700 Subject: First pass at reorganizing docs --- docs/_sidebar.md | 68 +++++++++++++++++++++++--------------------------------- 1 file changed, 28 insertions(+), 40 deletions(-) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 69170d8bb1..d439298dad 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,36 +1,50 @@ -* [Getting Started](README.md) - * [QMK Introduction](getting_started_introduction.md) - * [Install Build Tools](getting_started_build_tools.md) - * Alternative: [Vagrant Guide](getting_started_vagrant.md) - * [Build/Compile Instructions](getting_started_make_guide.md) - * [Flashing Firmware](flashing.md) - * [Contributing to QMK](contributing.md) - * [How to Use Github](getting_started_github.md) - * [Getting Help](getting_started_getting_help.md) - * [Complete Newbs Guide](newbs.md) * [Getting Started](newbs_getting_started.md) * [Building Your First Firmware](newbs_building_firmware.md) * [Flashing Firmware](newbs_flashing.md) * [Testing and Debugging](newbs_testing_debugging.md) +* [QMK Basics](README.md) + * [QMK Introduction](getting_started_introduction.md) + * [Contributing to QMK](contributing.md) + * [How to Use Github](getting_started_github.md) + * [Getting Help](getting_started_getting_help.md) + * [FAQ](faq.md) * [General FAQ](faq_general.md) * [Build/Compile QMK](faq_build.md) * [Debugging/Troubleshooting QMK](faq_debug.md) * [Keymap](faq_keymap.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) - * [Keyboard Guidelines](hardware_keyboard_guidelines.md) * [AVR Processors](hardware_avr.md) - * ARM Processors (TBD) * [Drivers](hardware_drivers.md) +* Reference + * [Keyboard Guidelines](hardware_keyboard_guidelines.md) + * [Config Options](config_options.md) + * [Keycodes](keycodes.md) + * [Documentation Best Practices](documentation_best_practices.md) + * [Documentation Templates](documentation_templates.md) + * [Glossary](reference_glossary.md) + * [Unit Testing](unit_testing.md) + * [Features](features.md) + * [Basic Keycodes](keycodes_basic.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) * [Command](feature_command.md) * [Dynamic Macros](feature_dynamic_macros.md) @@ -40,6 +54,7 @@ * [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) * [PS/2 Mouse](feature_ps2_mouse.md) * [RGB Lighting](feature_rgblight.md) @@ -53,34 +68,7 @@ * [Thermal Printer](feature_thermal_printer.md) * [Unicode](feature_unicode.md) * [Userspace](feature_userspace.md) - -* [Keycodes](keycodes.md) - * [Basic](keycodes_basic.md) - * [Quantum](quantum_keycodes.md) - * [Audio](feature_audio.md#audio-keycodes) - * [Backlight](feature_backlight.md#backlight-keycodes) - * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes) - * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes) - * [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) - * [Mod+Key](feature_advanced_keycodes.md#modifier-keys) - * [Mod Tap](feature_advanced_keycodes.md#mod-tap) - * [Mouse Keys](feature_mouse_keys.md#mapping-mouse-actions-to-keyboard-keys) - * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) - * [RGB Light](feature_rgblight.md#rgblight-keycodes) - * [RGB Matrix](feature_rgb_matrix.md#keycodes) - * [Shifted Keys](keycodes_us_ansi_shifted.md) - * [Stenography](feature_stenography.md#keycode-reference) - * [Swap Hands](feature_swap_hands.md#swap-keycodes) - * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) - -* 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](reference_glossary.md) - * [Keymap Overview](keymap.md) - * [Unit Testing](unit_testing.md) + * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) * For Makers and Modders * [Hand Wiring Guide](hand_wire.md) -- cgit v1.2.3 From eb19fb5b57487747d608fad986a70296da4deb12 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Sat, 25 Aug 2018 20:01:09 -0700 Subject: Helpful functions --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index d439298dad..a35014dd8c 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -36,6 +36,7 @@ * [Documentation Templates](documentation_templates.md) * [Glossary](reference_glossary.md) * [Unit Testing](unit_testing.md) + * [Useful Functions](ref_functions.md) * [Features](features.md) * [Basic Keycodes](keycodes_basic.md) -- cgit v1.2.3 From ac7b2d92bf1254803ec97c075e6d0c833dfd4146 Mon Sep 17 00:00:00 2001 From: yiancar Date: Thu, 4 Oct 2018 22:37:26 +0100 Subject: ARM SWD guide - Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links. --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index a35014dd8c..973428c9e0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -74,6 +74,7 @@ * For Makers and Modders * [Hand Wiring Guide](hand_wire.md) * [ISP Flashing Guide](isp_flashing_guide.md) + * [ARM Debugging Guide](arm_debugging.md) * For a Deeper Understanding * [How Keyboards Work](how_keyboards_work.md) -- cgit v1.2.3 From 43757cd985153ba4f620336003c20b3554c03678 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Wed, 10 Oct 2018 16:10:30 -0700 Subject: Cleanup learning newb links --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 973428c9e0..32e3c7eca0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -3,6 +3,7 @@ * [Building Your First Firmware](newbs_building_firmware.md) * [Flashing Firmware](newbs_flashing.md) * [Testing and Debugging](newbs_testing_debugging.md) + * [Learning Resources](newbs_learn_more_resources.md) * [QMK Basics](README.md) * [QMK Introduction](getting_started_introduction.md) -- cgit v1.2.3 From a7d05820a6258178b7ea440ee2781edf074d8f41 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Wed, 10 Oct 2018 12:38:10 -0700 Subject: Add documentation for Combo feature --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 32e3c7eca0..56a6463918 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -48,6 +48,7 @@ * [Backlight](feature_backlight.md) * [Bluetooth](feature_bluetooth.md) * [Bootmagic](feature_bootmagic.md) + * [Combos](feature_combo) * [Command](feature_command.md) * [Dynamic Macros](feature_dynamic_macros.md) * [Grave Escape](feature_grave_esc.md) -- cgit v1.2.3 From 480651cf9df5c0b7453f60dffe13ae5de665a120 Mon Sep 17 00:00:00 2001 From: noroadsleft <18669334+noroadsleft@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:12:11 -0700 Subject: Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) * Docs: newbs_learn_more_resources.md: formatting * Added QMK Git Conventions doc, initial version * Renamed contributing_qmk.md to newbs_best_practices.md * Updated per review by @drashna * Added navigation links * Updated to Best Practices doc * Minor updates to Learn More Resources doc Markdown formatting consistency because I'm particular about it. * Added Merge Conflict section to Best Practices doc --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 56a6463918..465f4657cd 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -3,6 +3,7 @@ * [Building Your First Firmware](newbs_building_firmware.md) * [Flashing Firmware](newbs_flashing.md) * [Testing and Debugging](newbs_testing_debugging.md) + * [Best Practices](newbs_best_practices.md) * [Learning Resources](newbs_learn_more_resources.md) * [QMK Basics](README.md) -- cgit v1.2.3 From 85688e5b52112c86895171d3dc8b26610480e932 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Fri, 26 Oct 2018 16:19:23 -0400 Subject: add support for encoders to core --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 465f4657cd..2c57380122 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -52,6 +52,7 @@ * [Combos](feature_combo) * [Command](feature_command.md) * [Dynamic Macros](feature_dynamic_macros.md) + * [Encoders](feature_encoders.md) * [Grave Escape](feature_grave_esc.md) * [Key Lock](feature_key_lock.md) * [Layouts](feature_layouts.md) -- cgit v1.2.3 From 408361402385ea938575956e9368b5f373edc629 Mon Sep 17 00:00:00 2001 From: yiancar Date: Sat, 10 Nov 2018 12:26:39 -0800 Subject: I2C driver docs (#4298) * I2C driver docs - Added I2C driver docs. - Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world. * Update docs/i2c_driver.md Co-Authored-By: yiancar * Update docs/i2c_driver.md Co-Authored-By: yiancar * Update docs/i2c_driver.md Co-Authored-By: yiancar * Update docs/i2c_driver.md Co-Authored-By: yiancar * GPIO release fix --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 2c57380122..67e81422a1 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -79,6 +79,7 @@ * [Hand Wiring Guide](hand_wire.md) * [ISP Flashing Guide](isp_flashing_guide.md) * [ARM Debugging Guide](arm_debugging.md) + * [I2C Driver](i2c_driver.md) * For a Deeper Understanding * [How Keyboards Work](how_keyboards_work.md) -- cgit v1.2.3 From d8f090e5592fd5b6fde35ae36e36f2473c716312 Mon Sep 17 00:00:00 2001 From: noroadsleft <18669334+noroadsleft@users.noreply.github.com> Date: Wed, 14 Nov 2018 18:32:28 -0800 Subject: Docs: Supporting a keyboard in the QMK Configurator (#4396) * Docs: Configurator Support * Minor updates * Updated keyboard.h example to use #pragma once per @drashna https://github.com/qmk/qmk_firmware/pull/4396#discussion_r232140934 * Add link to doc under Reference section Added to _sidebar.md and _summary.md * Changed doc title; minor tweaks Re-titled the doc as "Supporting Your Keyboard in QMK Configurator". Made some minor changes to the keyboard.h examples. * Added tags object to JSON example --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 67e81422a1..1fb5398d93 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -39,6 +39,7 @@ * [Glossary](reference_glossary.md) * [Unit Testing](unit_testing.md) * [Useful Functions](ref_functions.md) + * [Configurator Support](reference_configurator_support.md) * [Features](features.md) * [Basic Keycodes](keycodes_basic.md) -- cgit v1.2.3 From 59b2be6200e13166cf69ae04aa7a05ec5e837d79 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Wed, 5 Dec 2018 10:28:06 -0800 Subject: Re-order feature list in sidebar (#4555) Specifically, moved the shifted keycodes to the top of the 'Feature' list, so it's more visible. This way, all of the keycodes are at the top of the list, rather than having the shifted keys at the bottom, so they should be easier to find since they're all in one place. --- docs/_sidebar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 1fb5398d93..6338d69121 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -43,6 +43,7 @@ * [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) @@ -74,7 +75,6 @@ * [Thermal Printer](feature_thermal_printer.md) * [Unicode](feature_unicode.md) * [Userspace](feature_userspace.md) - * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) * For Makers and Modders * [Hand Wiring Guide](hand_wire.md) -- cgit v1.2.3 From 2ad2b73d685cf25268fa7d3726f45594edee70c4 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Fri, 7 Dec 2018 16:51:27 -0800 Subject: Add support for PR and Issue templates to QMK_firmware GitHub (#4494) * Add support document * Add Bug Report * Add GitHub Pull Request Template * Feature request issue template * Touch up feature request template * Add 'other issues' template * move support doc * Minor tweaks * More minor tweaks * Spleeling fix Co-Authored-By: drashna * CapiTALization fIXes Co-Authored-By: drashna * Use new issue URL Co-Authored-By: drashna * Add blanck issue template * Update the PR template * Formatting and additional changes * Update docs/support.md Co-Authored-By: drashna --- docs/_sidebar.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_sidebar.md') diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 6338d69121..b209c5e0b8 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -88,6 +88,7 @@ * Other Topics * [Using Eclipse with QMK](eclipse.md) + * [Support](support.md) * QMK Internals (In Progress) * [Defines](internals_defines.md) -- cgit v1.2.3