Add warning about peripheral encoders.

3 years ago · 47109641d8
1 changed files with 5 additions and 0 deletions
--- a/docs/docs/features/encoders.md
+++ b/docs/docs/features/encoders.md
@ -5,6 +5,11 @@ sidebar_label: Encoders
				@@ -5,6 +5,11 @@ sidebar_label: Encoders

 Existing support for encoders in ZMK is focused around the five pin EC11 rotary encoder with push button design used in the majority of current keyboard and macropad designs.

+
+:::note
+Encoders are currently only support on the left/central sides of splits. For progress on this, see [#728](https://github.com/zmkfirmware/zmk/pull/728).
+:::
+
 ## Enabling EC11 Encoders

 To enable encoders for boards that have existing encoder support, uncomment the `EC11_CONFIG=y` and `CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y` lines in your board's .conf file in your `zmk-config/config` folder. Save and push your changes, then download and flash the new firmware.