From 40d82906cb2556ead29e2288788c7a26caf1f026 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Wed, 28 Jun 2017 20:23:25 -0400 Subject: adds config options md --- docs/_summary.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index c5e29cb520..b08d86520e 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -18,6 +18,7 @@ * [Mouse keys](mouse_keys.md) * [FAQ: Creating a Keymap](faq_keymap.md) * [FAQ: Compiling QMK](faq_build.md) +* [The Config File](config_options.md) ### For hardware makers and modders * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) -- cgit v1.2.3 From d5244c6cf4939301b18ecf07650df6a6f9800e07 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 00:15:07 -0400 Subject: restructure keycode docs --- docs/_summary.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index b08d86520e..268ab9954a 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -9,6 +9,8 @@ * [Keymap overview](keymap.md) * [Custom Quantum Functions](custom_quantum_functions.md) * [Keycodes](keycodes.md) + * [Basic Keycodes](basic_keycodes.md) + * [Quantum Keycodes](quantum_keycodes.md) * [Layer switching](key_functions.md) * [Leader Key](leader_key.md) * [Macros](macros.md) -- cgit v1.2.3 From d59734d3b7f29b95645e96e8560b210f0991d744 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 10:35:09 -0400 Subject: restructure summary --- docs/_summary.md | 63 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 31 deletions(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 268ab9954a..f2acad3a71 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -1,35 +1,36 @@ +* Getting started + * [Introduction](home.md) + * [QMK Overview](qmk_overview.md) + * [Build Environment Setup](build_environment_setup.md) + * [Make instructions](make_instructions.md) + * [FAQ: Creating a Keymap](faq_keymap.md) + * [FAQ: Compiling QMK](faq_build.md) -### Getting started -* [Introduction](home.md) -* [QMK Overview](qmk_overview.md) -* [Build Environment Setup](build_environment_setup.md) -* [Make instructions](make_instructions.md) +* Features + * [Layer switching](key_functions.md) + * [Leader Key](leader_key.md) + * [Macros](macros.md) + * [Dynamic Macros](dynamic_macros.md) + * [Space Cadet](space_cadet_shift.md) + * [Tap Dance](tap_dance.md) + * [Mouse keys](mouse_keys.md) -### Making a keymap -* [Keymap overview](keymap.md) -* [Custom Quantum Functions](custom_quantum_functions.md) -* [Keycodes](keycodes.md) - * [Basic Keycodes](basic_keycodes.md) - * [Quantum Keycodes](quantum_keycodes.md) -* [Layer switching](key_functions.md) -* [Leader Key](leader_key.md) -* [Macros](macros.md) -* [Dynamic Macros](dynamic_macros.md) -* [Space Cadet](space_cadet_shift.md) -* [Tap Dance](tap_dance.md) -* [Mouse keys](mouse_keys.md) -* [FAQ: Creating a Keymap](faq_keymap.md) -* [FAQ: Compiling QMK](faq_build.md) -* [The Config File](config_options.md) +* Reference + * [Keymap overview](keymap.md) + * [Keycodes](keycodes.md) + * [Basic Keycodes](basic_keycodes.md) + * [Quantum Keycodes](quantum_keycodes.md) + * [The Config File](config_options.md) + * [Custom Quantum Functions](custom_quantum_functions.md) -### For hardware makers and modders -* [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) -* [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md) -* [Modding your keyboard](modding_your_keyboard.md) -* [Adding features to QMK](adding_features_to_qmk.md) -* [ISP flashing guide](isp_flashing_guide.md) +* For makers and modders + * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) + * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md) + * [Modding your keyboard](modding_your_keyboard.md) + * [Adding features to QMK](adding_features_to_qmk.md) + * [ISP flashing guide](isp_flashing_guide.md) -### Other topics -* [General FAQ](faq.md) -* [Differences from TMK](differences_from_tmk.md) -* [Using Eclipse with QMK](eclipse.md) +* Other topics + * [General FAQ](faq.md) + * [Differences from TMK](differences_from_tmk.md) + * [Using Eclipse with QMK](eclipse.md) -- cgit v1.2.3 From 391eae97e49de471a8320f05ed5c8976874aedb0 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 12:13:44 -0400 Subject: testing out new home --- docs/_summary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index f2acad3a71..f2229be694 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -6,7 +6,7 @@ * [FAQ: Creating a Keymap](faq_keymap.md) * [FAQ: Compiling QMK](faq_build.md) -* Features +* [Features](features/README.md) * [Layer switching](key_functions.md) * [Leader Key](leader_key.md) * [Macros](macros.md) -- cgit v1.2.3 From b75ad215c85a53c34e170dba3c62093fc8655362 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 12:25:29 -0400 Subject: use default base names --- docs/_summary.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index f2229be694..115132cd30 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -1,5 +1,4 @@ -* Getting started - * [Introduction](home.md) +* [Getting started](README.md) * [QMK Overview](qmk_overview.md) * [Build Environment Setup](build_environment_setup.md) * [Make instructions](make_instructions.md) -- cgit v1.2.3 From 409cb1af52f84e6c0a0387f8c4c68b1305a20ad8 Mon Sep 17 00:00:00 2001 From: skullY Date: Thu, 29 Jun 2017 10:46:23 -0700 Subject: Polish up custom_quantum_functions --- docs/_summary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 115132cd30..131b81d0d2 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -20,7 +20,7 @@ * [Basic Keycodes](basic_keycodes.md) * [Quantum Keycodes](quantum_keycodes.md) * [The Config File](config_options.md) - * [Custom Quantum Functions](custom_quantum_functions.md) + * [Customizing Functionality](custom_quantum_functions.md) * For makers and modders * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) -- cgit v1.2.3 From 4c7e66c31c345a258be538594a688e187d09419b Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 19:37:49 -0400 Subject: add file to summary --- docs/_summary.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 131b81d0d2..87ccda5e44 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -4,6 +4,7 @@ * [Make instructions](make_instructions.md) * [FAQ: Creating a Keymap](faq_keymap.md) * [FAQ: Compiling QMK](faq_build.md) + * [How to Github](how_to_github.md) * [Features](features/README.md) * [Layer switching](key_functions.md) -- cgit v1.2.3 From 3e3c3e2b246737b9c29dc22764c1ac689130bb50 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 22:12:24 -0400 Subject: start glossary --- docs/_summary.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 87ccda5e44..1b87399fbe 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -16,6 +16,7 @@ * [Mouse keys](mouse_keys.md) * Reference + * [Glossary](glossary.md) * [Keymap overview](keymap.md) * [Keycodes](keycodes.md) * [Basic Keycodes](basic_keycodes.md) -- cgit v1.2.3 From d8e29b53fe5d57f2102b77f0ce9932cdb8b021b2 Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 3 Jul 2017 01:30:36 -0700 Subject: Update a bunch of docs --- docs/_summary.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 1b87399fbe..975a92376a 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -23,15 +23,16 @@ * [Quantum Keycodes](quantum_keycodes.md) * [The Config File](config_options.md) * [Customizing Functionality](custom_quantum_functions.md) + * [Documentation Best Practices](documentation_best_practices.md) * For makers and modders * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md) * [Modding your keyboard](modding_your_keyboard.md) + * [Understanding QMK](understanding_qmk.md) * [Adding features to QMK](adding_features_to_qmk.md) * [ISP flashing guide](isp_flashing_guide.md) * Other topics * [General FAQ](faq.md) - * [Differences from TMK](differences_from_tmk.md) * [Using Eclipse with QMK](eclipse.md) -- cgit v1.2.3 From c12f19107f134332d1bd20d0f4f3574e7cb3479d Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 3 Jul 2017 12:30:26 -0700 Subject: update the summary --- docs/_summary.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 975a92376a..5b6ec70013 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -1,6 +1,7 @@ * [Getting started](README.md) * [QMK Overview](qmk_overview.md) * [Build Environment Setup](build_environment_setup.md) + * [Vagrant Guide](vagrant_guide.md) * [Make instructions](make_instructions.md) * [FAQ: Creating a Keymap](faq_keymap.md) * [FAQ: Compiling QMK](faq_build.md) @@ -29,9 +30,12 @@ * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md) * [Modding your keyboard](modding_your_keyboard.md) - * [Understanding QMK](understanding_qmk.md) * [Adding features to QMK](adding_features_to_qmk.md) * [ISP flashing guide](isp_flashing_guide.md) + +* For Deeper Understanding + * [How Keyboards Work](basic_how_keyboards_work.md) + * [Understanding QMK](understanding_qmk.md) * Other topics * [General FAQ](faq.md) -- cgit v1.2.3 From 9cadba7b895a81f329a4c2eee253e57c11715b80 Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 3 Jul 2017 12:39:15 -0700 Subject: Add missing files to _summary.md --- docs/_summary.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 5b6ec70013..8a649a3370 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -15,6 +15,7 @@ * [Space Cadet](space_cadet_shift.md) * [Tap Dance](tap_dance.md) * [Mouse keys](mouse_keys.md) + * [Unicode](unicode.md) * Reference * [Glossary](glossary.md) @@ -22,21 +23,23 @@ * [Keycodes](keycodes.md) * [Basic Keycodes](basic_keycodes.md) * [Quantum Keycodes](quantum_keycodes.md) - * [The Config File](config_options.md) + * [The `config.h` File](config_options.md) * [Customizing Functionality](custom_quantum_functions.md) * [Documentation Best Practices](documentation_best_practices.md) + * [Unit Testing](unit_testing.md) -* For makers and modders +* For Makers and Modders * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) - * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md) - * [Modding your keyboard](modding_your_keyboard.md) * [Adding features to QMK](adding_features_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 Deeper Understanding +* For a Deeper Understanding * [How Keyboards Work](basic_how_keyboards_work.md) * [Understanding QMK](understanding_qmk.md) -* Other topics +* Other Topics * [General FAQ](faq.md) * [Using Eclipse with QMK](eclipse.md) -- cgit v1.2.3 From 14c5160b1a94d5dc416002791b3c207ba0dca789 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Mon, 17 Jul 2017 15:01:33 -0400 Subject: Update _summary.md --- docs/_summary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 8a649a3370..162cad7873 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -7,7 +7,7 @@ * [FAQ: Compiling QMK](faq_build.md) * [How to Github](how_to_github.md) -* [Features](features/README.md) +* [Features](features.md) * [Layer switching](key_functions.md) * [Leader Key](leader_key.md) * [Macros](macros.md) -- cgit v1.2.3 From 26fb063be3b38cf76908163c6dad3168c738886c Mon Sep 17 00:00:00 2001 From: Joe Wasson Date: Thu, 27 Jul 2017 11:59:17 -0700 Subject: Link to steno docs from summary page. --- docs/_summary.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'docs/_summary.md') diff --git a/docs/_summary.md b/docs/_summary.md index 162cad7873..723377de98 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -1,4 +1,4 @@ -* [Getting started](README.md) +* [Getting started](README.md) * [QMK Overview](qmk_overview.md) * [Build Environment Setup](build_environment_setup.md) * [Vagrant Guide](vagrant_guide.md) @@ -16,6 +16,7 @@ * [Tap Dance](tap_dance.md) * [Mouse keys](mouse_keys.md) * [Unicode](unicode.md) + * [Stenography](stenography.md) * Reference * [Glossary](glossary.md) @@ -27,7 +28,7 @@ * [Customizing Functionality](custom_quantum_functions.md) * [Documentation Best Practices](documentation_best_practices.md) * [Unit Testing](unit_testing.md) - + * For Makers and Modders * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md) * [Adding features to QMK](adding_features_to_qmk.md) @@ -39,7 +40,7 @@ * For a Deeper Understanding * [How Keyboards Work](basic_how_keyboards_work.md) * [Understanding QMK](understanding_qmk.md) - + * Other Topics * [General FAQ](faq.md) * [Using Eclipse with QMK](eclipse.md) -- cgit v1.2.3