From a685d88744dcf2c9f901fff2d136a129c83d83ab Mon Sep 17 00:00:00 2001 From: innovaker <66737976+innovaker@users.noreply.github.com> Date: Wed, 11 Nov 2020 21:24:19 +0000 Subject: [PATCH] refactor(docs): Change `feature` to `features` Makes a better URL. --- docs/blog/2020-08-12-zmk-sotf-1.md | 6 +++--- docs/docs/customization.md | 2 +- docs/docs/dev-guide-new-shield.md | 2 +- docs/docs/{feature => features}/displays.md | 0 docs/docs/{feature => features}/encoders.md | 0 docs/docs/{feature => features}/keymaps.md | 0 docs/docs/{feature => features}/underglow.md | 0 docs/docs/intro.md | 6 +++--- docs/sidebars.js | 8 ++++---- 9 files changed, 12 insertions(+), 12 deletions(-) rename docs/docs/{feature => features}/displays.md (100%) rename docs/docs/{feature => features}/encoders.md (100%) rename docs/docs/{feature => features}/keymaps.md (100%) rename docs/docs/{feature => features}/underglow.md (100%) diff --git a/docs/blog/2020-08-12-zmk-sotf-1.md b/docs/blog/2020-08-12-zmk-sotf-1.md index b5b2046d..afa03405 100644 --- a/docs/blog/2020-08-12-zmk-sotf-1.md +++ b/docs/blog/2020-08-12-zmk-sotf-1.md @@ -15,13 +15,13 @@ With interest and Discord activity growing, it seemed important to lay out the p There's been lots of various activity in ZMK land! -- [Nicell](https://github.com/Nicell) (nice!nano creator) contributed initial [RGB Underglow](/docs/feature/underglow) ([#64](https://github.com/zmkfirmware/zmk/pull/64)) support to ZMK. +- [Nicell](https://github.com/Nicell) (nice!nano creator) contributed initial [RGB Underglow](/docs/features/underglow) ([#64](https://github.com/zmkfirmware/zmk/pull/64)) support to ZMK. - Tons of [documentation](/docs) work. -- Refactoring ([#73](https://github.com/zmkfirmware/zmk/pull/73), [#74](https://github.com/zmkfirmware/zmk/pull/74)) of [keymaps](/docs/feature/keymaps) to make them simpler for users. +- Refactoring ([#73](https://github.com/zmkfirmware/zmk/pull/73), [#74](https://github.com/zmkfirmware/zmk/pull/74)) of [keymaps](/docs/features/keymaps) to make them simpler for users. - Mod-Tap Behavior (docs coming!) is much improved ([#69](https://github.com/zmkfirmware/zmk/pull/69)) and usable now. - An initial [`setup.sh`](http://localhost:3000/docs/user-setup#user-config-setup-script) script was created, allowing users to quickly bootstrap a "user config" setup and push it to GitHub, where GitHub Actions will build the firmware for you. - Corne shield ([#80](https://github.com/zmkfirmware/zmk/pull/80)) shield definition was added. -- Initial [encoder](/docs/feature/encoders) support ([#61](https://github.com/zmkfirmware/zmk/pull/61)) was added. +- Initial [encoder](/docs/features/encoders) support ([#61](https://github.com/zmkfirmware/zmk/pull/61)) was added. ## Bugs and Showstoppers diff --git a/docs/docs/customization.md b/docs/docs/customization.md index d3372da2..d0d37491 100644 --- a/docs/docs/customization.md +++ b/docs/docs/customization.md @@ -26,7 +26,7 @@ various config settings that can be commented/uncommented to modify how your fir ## Keymap Once you have the basic user config completed, you can find the keymap file in `config/.keymap` and customize from there. -Refer to the [Keymap](/docs/feature/keymaps) documentation to learn more. +Refer to the [Keymap](/docs/features/keymaps) documentation to learn more. ## Publishing diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/dev-guide-new-shield.md index 70a847cb..f095ab57 100644 --- a/docs/docs/dev-guide-new-shield.md +++ b/docs/docs/dev-guide-new-shield.md @@ -477,7 +477,7 @@ Add the following line to your keymap file to add default encoder behavior bindi sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>; ``` -Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](/docs/feature/encoders) and [Keymap](/docs/feature/keymaps) feature documentation for more details. +Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](/docs/features/encoders) and [Keymap](/docs/features/keymaps) feature documentation for more details. diff --git a/docs/docs/feature/displays.md b/docs/docs/features/displays.md similarity index 100% rename from docs/docs/feature/displays.md rename to docs/docs/features/displays.md diff --git a/docs/docs/feature/encoders.md b/docs/docs/features/encoders.md similarity index 100% rename from docs/docs/feature/encoders.md rename to docs/docs/features/encoders.md diff --git a/docs/docs/feature/keymaps.md b/docs/docs/features/keymaps.md similarity index 100% rename from docs/docs/feature/keymaps.md rename to docs/docs/features/keymaps.md diff --git a/docs/docs/feature/underglow.md b/docs/docs/features/underglow.md similarity index 100% rename from docs/docs/feature/underglow.md rename to docs/docs/features/underglow.md diff --git a/docs/docs/intro.md b/docs/docs/intro.md index c76e4b7c..55456d39 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -22,9 +22,9 @@ ZMK is currently missing some features found in other popular firmware. This tab | [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | | [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ | | [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ | -| [Encoders](feature/encoders)[^1] | ✅ | | ✅ | -| [OLED Display Support](feature/displays)[^2] | 🚧 | 🚧 | ✅ | -| [RGB Underglow](feature/underglow) | ✅ | ✅ | ✅ | +| [Encoders](features/encoders)[^1] | ✅ | | ✅ | +| [OLED Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ | +| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ | | One Shot Keys | 🚧 | ✅ | ✅ | | Combo Keys | 🚧 | | ✅ | | Macros | 🚧 | ✅ | ✅ | diff --git a/docs/sidebars.js b/docs/sidebars.js index 15d531ec..d64d96c1 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -9,10 +9,10 @@ module.exports = { "troubleshooting", ], Features: [ - "feature/keymaps", - "feature/displays", - "feature/encoders", - "feature/underglow", + "features/keymaps", + "features/displays", + "features/encoders", + "features/underglow", ], Behaviors: [ "behavior/key-press",