diff --git a/docs/blog/2020-08-12-zmk-sotf-1.md b/docs/blog/2020-08-12-zmk-sotf-1.md index 4fd7a586..4b1aaffe 100644 --- a/docs/blog/2020-08-12-zmk-sotf-1.md +++ b/docs/blog/2020-08-12-zmk-sotf-1.md @@ -21,7 +21,7 @@ There's been lots of various activity in ZMK land! - Mod-Tap Behavior (docs coming!) is much improved ([#69](https://github.com/zmkfirmware/zmk/pull/69)) and usable now. - An initial [`setup.sh`](/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/keymaps/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/config/encoders.md b/docs/docs/config/encoders.md index 89dc455f..2052fc9d 100644 --- a/docs/docs/config/encoders.md +++ b/docs/docs/config/encoders.md @@ -3,7 +3,7 @@ title: Encoder Configuration sidebar_label: Encoders --- -See the [Encoders informational page](../keymaps/encoders.md) for more details, including instructions for adding encoder support to a board. +See the [Encoders informational page](../features/encoders.md) for more details, including instructions for adding encoder support to a board. See [Configuration Overview](index.md) for instructions on how to change these settings. diff --git a/docs/docs/development/new-shield.mdx b/docs/docs/development/new-shield.mdx index 5e7e3f8c..adebb7ce 100644 --- a/docs/docs/development/new-shield.mdx +++ b/docs/docs/development/new-shield.mdx @@ -591,7 +591,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](../keymaps/encoders.md) and [Keymap](../keymaps/index.mdx) feature documentation for more details. +Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](../features/encoders.md) and [Keymap](../keymaps/index.mdx) feature documentation for more details. diff --git a/docs/docs/keymaps/encoders.md b/docs/docs/features/encoders.md similarity index 89% rename from docs/docs/keymaps/encoders.md rename to docs/docs/features/encoders.md index c945fe24..cc5bb708 100644 --- a/docs/docs/keymaps/encoders.md +++ b/docs/docs/features/encoders.md @@ -19,13 +19,13 @@ Keyboards and macropads with encoder support will typically take the two EC11 pi ### Rotation -Rotation is handled separately as a type of sensor. The behavior for this is set in `sensor-bindings`. See [Sensor Rotation](behaviors/sensor-rotate.md) for customizing this behavior. +Rotation is handled separately as a type of sensor. The behavior for this is set in `sensor-bindings`. See [Sensor Rotation](../keymaps/behaviors/sensor-rotate.md) for customizing this behavior. ```dts sensor-bindings = ; ``` -- `BINDING` is either a user-defined behavior, or `&inc_dec_kp` for key presses (see [Key Press](behaviors/key-press.md) for details on available keycodes). +- `BINDING` is either a user-defined behavior, or `&inc_dec_kp` for key presses (see [Key Press](../keymaps/behaviors/key-press.md) for details on available keycodes). - `CW_KEY` is the keycode activated by a clockwise turn. - `CCW_KEY` is the keycode activated by a counter-clockwise turn. diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 4b6af473..22e17d43 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -26,7 +26,7 @@ ZMK is currently missing some features found in other popular firmware. This tab | [Tap-Dance](keymaps/behaviors/tap-dance.mdx) | ✅ | ✅[^2] | ✅ | | [Keyboard Codes](keymaps/list-of-codes.mdx#keyboard) | ✅ | ✅ | ✅ | | [Media](keymaps/list-of-codes.mdx#media-controls) & [Consumer](keymaps/list-of-codes.mdx#consumer-controls) Codes | ✅ | ✅ | ✅ | -| [Encoders](keymaps/encoders.md) | ✅ | ✅ | ✅ | +| [Encoders](features/encoders.md) | ✅ | ✅ | ✅ | | [Display Support](features/displays.md)[^1] | 🚧 | 🚧 | ✅ | | [RGB Underglow](features/underglow.md) | ✅ | ✅ | ✅ | | [Backlight](features/backlight.mdx) | ✅ | ✅ | ✅ | diff --git a/docs/sidebars.js b/docs/sidebars.js index 539fb5c5..ac4ddc30 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -37,6 +37,7 @@ module.exports = { "features/debouncing", "features/battery", "features/soft-off", + "features/encoders", "features/displays", "features/backlight", "features/underglow", @@ -87,7 +88,6 @@ module.exports = { "keymaps/modifiers", "keymaps/combos", "keymaps/conditional-layers", - "keymaps/encoders", "keymaps/list-of-codes", ], }, diff --git a/docs/static/_redirects b/docs/static/_redirects index 485d19aa..ea629e87 100644 --- a/docs/static/_redirects +++ b/docs/static/_redirects @@ -3,6 +3,6 @@ /docs/features/combos /docs/keymaps/combos 301 /docs/features/conditional-layers /docs/keymaps/conditional-layers 301 /docs/features/encoders /docs/keymaps/encoders 301 +/docs/codes/modifiers /docs/keymaps/modifiers 301 /docs/codes/* /docs/keymaps/list-of-codes 301 -/docs/troubleshooting#split-keyboard-halves-unable-to-pair /docs/troubleshooting/connection-issues#split-keyboard-halves-unable-to-pair 301 -/docs/features/beta-testing /docs/features/modules 301 \ No newline at end of file +/docs/features/beta-testing /docs/features/modules#beta-testing 301 \ No newline at end of file diff --git a/zmk-modules b/zmk-modules new file mode 160000 index 00000000..ec0866f9 --- /dev/null +++ b/zmk-modules @@ -0,0 +1 @@ +Subproject commit ec0866f9f833cf4a006509740b374e87002d399e