Browse Source

make sure all our redirects are in order

skullY 5 years ago
parent
commit
961477c791
7 changed files with 51 additions and 55 deletions
  1. 1 1
      docs/README.md
  2. 1 1
      docs/_summary.md
  3. 16 0
      docs/feature_advanced_keycodes.md
  4. 0 17
      docs/getting_started_getting_help.md
  5. 6 0
      docs/hand_wire.md
  6. 18 1
      docs/index.html
  7. 9 35
      docs/support.md

+ 1 - 1
docs/README.md

@@ -28,7 +28,7 @@ QMK has lots of [features](features.md) to explore, and a good deal of reference
 
 ## Need help?
 
-Check out the [support page](getting_started_getting_help.md) to see how you can get help using QMK.
+Check out the [support page](support.md) to see how you can get help using QMK.
 
 ## Give Back
 

+ 1 - 1
docs/_summary.md

@@ -4,7 +4,7 @@
   * [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)
+  * [Getting Help/Support](support.md)
   * [Other Resources](newbs_learn_more_resources.md)
 
 * FAQs

+ 16 - 0
docs/feature_advanced_keycodes.md

@@ -62,3 +62,19 @@ These allow you to combine a modifier with a keycode. When pressed, the keydown
 |`HYPR(kc)`|                               |Hold Left Control, Shift, Alt and GUI and press `kc`|
 
 You can also chain them, for example `LCTL(LALT(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
+
+# Legacy Content
+
+This 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.
+
+## Mod-Tap :id=mod-tap
+
+* [Mod-Tap](mod_tap.md)
+
+## One Shot Keys :id=one-shot-keys
+
+* [One Shot Keys](one_shot_keys.md)
+
+## Tap-Hold Configuration Options :id=tap-hold-configuration-options
+
+* [Tap-Hold Configuration Options](tap_hold.md)

+ 0 - 17
docs/getting_started_getting_help.md

@@ -1,17 +0,0 @@
-# Getting Help
-
-There are a lot of resources for getting help with QMK.
-
-Please read our [Code of Conduct](https://qmk.fm/coc/) before participating in any of our community spaces.
-
-## Realtime Chat
-
-If 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.
-
-## OLKB Subreddit
-
-The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com).
-
-## Github Issues
-
-You 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.

+ 6 - 0
docs/hand_wire.md

@@ -235,4 +235,10 @@ There are a lot of possibilities inside the firmware - explore [docs.qmk.fm](htt
 - [Masterzen's "Handwired keyboard build log"](http://www.masterzen.fr/2018/12/16/handwired-keyboard-build-log-part-1/)
 
 
+# Legacy Content
 
+This 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.
+
+## Preamble: How a Keyboard Matrix Works (and why we need diodes) :id=preamble-how-a-keyboard-matrix-works-and-why-we-need-diodes
+
+* [How a Keyboard Matrix Works](how_a_matrix_works.md)

+ 18 - 1
docs/index.html

@@ -23,10 +23,26 @@
   <script>
     window.$docsify = {
       alias: {
+        // Translation aliases
         '/en/(.*)': '/$1',
         '/en-us/(.*)': '/$1',
         '/en-gb/(.*)': '/$1',
         '/.*/_langs.md': '/_langs.md',
+
+        // Moved pages
+        '/adding_a_keyboard_to_qmk': '/hardware_keyboard_guidelines',
+        '/build_environment_setup': '/getting_started_build_tools',
+        '/dynamic_macros': '/feature_dynamic_macros',
+        '/feature_common_shortcuts': '/feature_advanced_keycodes',
+        '/glossary': '/reference_glossary',
+        '/key_lock': '/feature_key_lock',
+        '/make_instructions': '/getting_started_make_guide',
+        '/porting_your_keyboard_to_qmk': '/hardware_avr',
+        '/space_cadet_shift': '/feature_space_cadet_shift',
+        '/getting_started_getting_help': '/support',
+        '/tap_dance': '/feature_tap_dance',
+        '/unicode': '/feature_unicode',
+        '/python_development': '/cli_development',
       },
       basePath: '/',
       name: 'QMK Firmware',
@@ -136,7 +152,8 @@
   <script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
   <script src="//unpkg.com/prismjs/components/prism-makefile.min.js"></script>
   <script>
-    // Register the offline cache worker
+    // Register the cache worker for offline viewing mode
+    // https://docsify.now.sh/pwa
     if (typeof navigator.serviceWorker !== 'undefined') {
       navigator.serviceWorker.register('sw.js')
     }

+ 9 - 35
docs/support.md

@@ -1,43 +1,17 @@
-# Support
+# Getting Help
 
-If 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.
-
-Don't forget to read our [Code of Conduct](https://qmk.fm/coc/).
-
-## Help! I don't know where to start! 
-
-If 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.
-
-If that's an issue, hop onto the [QMK Configurator](https://config.qmk.fm), as that will handle a majority of what you need there. 
-
-## Help! I'm having issues flashing!
-
-First, 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. 
-
-## Help, I have an issue that isn't covered by the links above
+There are a lot of resources for getting help with QMK.
 
-Okay, 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).  
+Please read our [Code of Conduct](https://qmk.fm/coc/) before participating in any of our community spaces.
 
-If you can't find anything, then please open a [new issue](https://github.com/qmk/qmk_firmware/issues/new)!
+## Realtime Chat
 
-## What if I found a bug? 
-
-Then 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.
-
-## But `git` and `GitHub` are intimidating! 
-
-Don'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. 
-
-Additionally, you can find additional `git` and GitHub related links [here](newbs_learn_more_resources.md).
-
-## I have a Keyboard that I want to add support for
-
-Awesome! Open up a Pull Request for it. We'll review the code, and merge it!  
+If 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.
 
-### What if I want to do brand it with `QMK`? 
+## OLKB Subreddit
 
-That's amazing! We would love to assist you with that! 
+The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com).
 
-In 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.
+## Github Issues
 
-If you have any questions about this, open an issue or head to [Discord](https://discord.gg/Uq7gcHh). 
+You 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.