aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/README.md2
-rw-r--r--docs/_summary.md2
-rw-r--r--docs/feature_advanced_keycodes.md16
-rw-r--r--docs/getting_started_getting_help.md17
-rw-r--r--docs/hand_wire.md6
-rw-r--r--docs/index.html19
-rw-r--r--docs/support.md44
7 files changed, 51 insertions, 55 deletions
diff --git a/docs/README.md b/docs/README.md
index 30ce9ae2d..4fd872688 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -28,7 +28,7 @@ QMK has lots of [features](features.md) to explore, and a good deal of reference
28 28
29## Need help? 29## Need help?
30 30
31Check out the [support page](getting_started_getting_help.md) to see how you can get help using QMK. 31Check out the [support page](support.md) to see how you can get help using QMK.
32 32
33## Give Back 33## Give Back
34 34
diff --git a/docs/_summary.md b/docs/_summary.md
index 0aadb1548..6c2ec6ec9 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -4,7 +4,7 @@
4 * [Building Your First Firmware](newbs_building_firmware.md) 4 * [Building Your First Firmware](newbs_building_firmware.md)
5 * [Flashing Firmware](newbs_flashing.md) 5 * [Flashing Firmware](newbs_flashing.md)
6 * [Testing and Debugging](newbs_testing_debugging.md) 6 * [Testing and Debugging](newbs_testing_debugging.md)
7 * [Getting Help](getting_started_getting_help.md) 7 * [Getting Help/Support](support.md)
8 * [Other Resources](newbs_learn_more_resources.md) 8 * [Other Resources](newbs_learn_more_resources.md)
9 9
10* FAQs 10* FAQs
diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md
index 92713a0eb..4f970c6b3 100644
--- a/docs/feature_advanced_keycodes.md
+++ b/docs/feature_advanced_keycodes.md
@@ -62,3 +62,19 @@ These allow you to combine a modifier with a keycode. When pressed, the keydown
62|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`| 62|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`|
63 63
64You can also chain them, for example `LCTL(LALT(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress. 64You can also chain them, for example `LCTL(LALT(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
65
66# Legacy Content
67
68This page used to encompass a large set of features. We have moved many sections that used to be part of this page to their own pages. Everything below this point is simply a redirect so that people following old links on the web find what they're looking for.
69
70## Mod-Tap :id=mod-tap
71
72* [Mod-Tap](mod_tap.md)
73
74## One Shot Keys :id=one-shot-keys
75
76* [One Shot Keys](one_shot_keys.md)
77
78## Tap-Hold Configuration Options :id=tap-hold-configuration-options
79
80* [Tap-Hold Configuration Options](tap_hold.md)
diff --git a/docs/getting_started_getting_help.md b/docs/getting_started_getting_help.md
deleted file mode 100644
index 79c1dbc1b..000000000
--- a/docs/getting_started_getting_help.md
+++ /dev/null
@@ -1,17 +0,0 @@
1# Getting Help
2
3There are a lot of resources for getting help with QMK.
4
5Please read our [Code of Conduct](https://qmk.fm/coc/) before participating in any of our community spaces.
6
7## Realtime Chat
8
9If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/Uq7gcHh). There is usually somebody online, and there are a bunch of very helpful people there.
10
11## OLKB Subreddit
12
13The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com).
14
15## Github Issues
16
17You can open an [issue on GitHub](https://github.com/qmk/qmk_firmware/issues). This is especially handy when your issue will require long-term discussion or debugging.
diff --git a/docs/hand_wire.md b/docs/hand_wire.md
index 75fd546fe..0c5b4f45f 100644
--- a/docs/hand_wire.md
+++ b/docs/hand_wire.md
@@ -235,4 +235,10 @@ There are a lot of possibilities inside the firmware - explore [docs.qmk.fm](htt
235- [Masterzen's "Handwired keyboard build log"](http://www.masterzen.fr/2018/12/16/handwired-keyboard-build-log-part-1/) 235- [Masterzen's "Handwired keyboard build log"](http://www.masterzen.fr/2018/12/16/handwired-keyboard-build-log-part-1/)
236 236
237 237
238# Legacy Content
238 239
240This page used to include more content. We have moved a section that used to be part of this page its own page. Everything below this point is simply a redirect so that people following old links on the web find what they're looking for.
241
242## Preamble: How a Keyboard Matrix Works (and why we need diodes) :id=preamble-how-a-keyboard-matrix-works-and-why-we-need-diodes
243
244* [How a Keyboard Matrix Works](how_a_matrix_works.md)
diff --git a/docs/index.html b/docs/index.html
index 3ab8f7846..4351ce1dd 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -23,10 +23,26 @@
23 <script> 23 <script>
24 window.$docsify = { 24 window.$docsify = {
25 alias: { 25 alias: {
26 // Translation aliases
26 '/en/(.*)': '/$1', 27 '/en/(.*)': '/$1',
27 '/en-us/(.*)': '/$1', 28 '/en-us/(.*)': '/$1',
28 '/en-gb/(.*)': '/$1', 29 '/en-gb/(.*)': '/$1',
29 '/.*/_langs.md': '/_langs.md', 30 '/.*/_langs.md': '/_langs.md',
31
32 // Moved pages
33 '/adding_a_keyboard_to_qmk': '/hardware_keyboard_guidelines',
34 '/build_environment_setup': '/getting_started_build_tools',
35 '/dynamic_macros': '/feature_dynamic_macros',
36 '/feature_common_shortcuts': '/feature_advanced_keycodes',
37 '/glossary': '/reference_glossary',
38 '/key_lock': '/feature_key_lock',
39 '/make_instructions': '/getting_started_make_guide',
40 '/porting_your_keyboard_to_qmk': '/hardware_avr',
41 '/space_cadet_shift': '/feature_space_cadet_shift',
42 '/getting_started_getting_help': '/support',
43 '/tap_dance': '/feature_tap_dance',
44 '/unicode': '/feature_unicode',
45 '/python_development': '/cli_development',
30 }, 46 },
31 basePath: '/', 47 basePath: '/',
32 name: 'QMK Firmware', 48 name: 'QMK Firmware',
@@ -136,7 +152,8 @@
136 <script src="//unpkg.com/prismjs/components/prism-json.min.js"></script> 152 <script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
137 <script src="//unpkg.com/prismjs/components/prism-makefile.min.js"></script> 153 <script src="//unpkg.com/prismjs/components/prism-makefile.min.js"></script>
138 <script> 154 <script>
139 // Register the offline cache worker 155 // Register the cache worker for offline viewing mode
156 // https://docsify.now.sh/pwa
140 if (typeof navigator.serviceWorker !== 'undefined') { 157 if (typeof navigator.serviceWorker !== 'undefined') {
141 navigator.serviceWorker.register('sw.js') 158 navigator.serviceWorker.register('sw.js')
142 } 159 }
diff --git a/docs/support.md b/docs/support.md
index d960992c3..79c1dbc1b 100644
--- a/docs/support.md
+++ b/docs/support.md
@@ -1,43 +1,17 @@
1# Support 1# Getting Help
2 2
3If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/Uq7gcHh). There is usually somebody online, and there are a bunch of very helpful people there. 3There are a lot of resources for getting help with QMK.
4
5Don't forget to read our [Code of Conduct](https://qmk.fm/coc/).
6
7## Help! I don't know where to start!
8
9If this is the case, then you should start with our [Newbs Guide](newbs.md). There is a lot of great info there, and that should cover everything you need to get started.
10
11If that's an issue, hop onto the [QMK Configurator](https://config.qmk.fm), as that will handle a majority of what you need there.
12
13## Help! I'm having issues flashing!
14
15First, head to the [Compiling/Flashing FAQ Page](faq_build.md). There is a good deal of info there, and you'll find a bunch of solutions to common issues there.
16
17## Help, I have an issue that isn't covered by the links above
18 4
19Okay, that's fine. Then please check the [open issues in our GitHub](https://github.com/qmk/qmk_firmware/issues) to see if somebody is experiencing the same thing (make sure it's not just similar, but actually the same). 5Please read our [Code of Conduct](https://qmk.fm/coc/) before participating in any of our community spaces.
20 6
21If you can't find anything, then please open a [new issue](https://github.com/qmk/qmk_firmware/issues/new)! 7## Realtime Chat
22 8
23## What if I found a bug? 9If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/Uq7gcHh). There is usually somebody online, and there are a bunch of very helpful people there.
24
25Then please open an [issue](https://github.com/qmk/qmk_firmware/issues/new), and if you know how to fix it, open up a Pull Request on GitHub with the fix.
26
27## But `git` and `GitHub` are intimidating!
28
29Don't worry, we have some pretty nice [Guidelines](newbs_git_best_practices.md) on how to start using `git` and GitHub to make things easier to develop.
30
31Additionally, you can find additional `git` and GitHub related links [here](newbs_learn_more_resources.md).
32
33## I have a Keyboard that I want to add support for
34
35Awesome! Open up a Pull Request for it. We'll review the code, and merge it!
36 10
37### What if I want to do brand it with `QMK`? 11## OLKB Subreddit
38 12
39That's amazing! We would love to assist you with that! 13The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com).
40 14
41In fact, we have a [whole page](https://qmk.fm/powered/) dedicated to adding QMK Branding to your page and keyboard. This covers pretty much everything you need (knowledge and images) to officially support QMK. 15## Github Issues
42 16
43If you have any questions about this, open an issue or head to [Discord](https://discord.gg/Uq7gcHh). 17You can open an [issue on GitHub](https://github.com/qmk/qmk_firmware/issues). This is especially handy when your issue will require long-term discussion or debugging.