fixup! docs: Add initial pointer docs.

zmkfirmware · Dec 9, 2024 · 6317f89 · 6317f89
1 parent 9fbead1
commit 6317f89
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/docs/docs/config/pointing.md b/docs/docs/config/pointing.md
@@ -9,14 +9,14 @@ See [Configuration Overview](index.md) for instructions on how to change these s
 
 ## Kconfig
 
-Definition file: [zmk/app/mouse/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/mouse/Kconfig)
+Definition file: [zmk/app/pointing/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/pointing/Kconfig)
 
 ### General
 
-| Config                              | Type | Description                                                                | Default |
-| ----------------------------------- | ---- | -------------------------------------------------------------------------- | ------- |
-| `CONFIG_ZMK_MOUSE`                  | bool | Enable the general pointing/mouse functionality                            | n       |
-| `CONFIG_ZMK_MOUSE_SMOOTH_SCROLLING` | bool | Enable smooth scrolling HID functionality (via HID Resolution Multipliers) | n       |
+| Config                                 | Type | Description                                                                | Default |
+| -------------------------------------- | ---- | -------------------------------------------------------------------------- | ------- |
+| `CONFIG_ZMK_POINTING`                  | bool | Enable the general pointing/mouse functionality                            | n       |
+| `CONFIG_ZMK_POINTING_SMOOTH_SCROLLING` | bool | Enable smooth scrolling HID functionality (via HID Resolution Multipliers) | n       |
 
 ### Advanced Settings
 

diff --git a/docs/docs/features/pointing.md b/docs/docs/features/pointing.md
@@ -6,7 +6,7 @@ ZMK supports physical pointing devices, as well as [mouse emulation behaviors](.
 
 ## Configuration
 
-To enable the pointer functionality, you must set `CONFIG_ZMK_MOUSE=y` in your config. See the [pointer configuration](../config/pointing.md) for the full details.
+To enable the pointer functionality, you must set `CONFIG_ZMK_POINTING=y` in your config. See the [pointer configuration](../config/pointing.md) for the full details.
 
 :::warning
 

diff --git a/docs/docs/keymaps/behaviors/mouse-emulation.md b/docs/docs/keymaps/behaviors/mouse-emulation.md
@@ -19,7 +19,7 @@ The mouse functionality will not work over BLE until that is done.
 To use any of the behaviors documented here, the ZMK mouse feature must be enabled explicitly via a config option:
 
 ```
-CONFIG_ZMK_MOUSE=y
+CONFIG_ZMK_POINTING=y
 ```
 
 ## Mouse Emulation Defines
@@ -35,8 +35,8 @@ provided by ZMK near the top:
 Should you wish to override the default movement or scrolling max velocities, you can define the defaults before including the header, e.g.:
 
 ```c
-#define ZMK_MOUSE_DEFAULT_MOVE_VAL 1500  // default: 600
-#define ZMK_MOUSE_DEFAULT_SCRL_VAL 20    // default: 10
+#define ZMK_POINTING_DEFAULT_MOVE_VAL 1500  // default: 600
+#define ZMK_POINTING_DEFAULT_SCRL_VAL 20    // default: 10
 
 #include <dt-bindings/zmk/mouse.h>
 ```
@@ -166,7 +166,7 @@ The following will send a scroll left event to the host when pressed/held:
 
 :::note
 
-If you enabled [smooth scrolling](../../config/pointing.md#kconfig) then you will want to use the same `MOVE_UP`, `MOVE_DOWN`, etc values instead of the smaller `SCRL_*` parameters.
+If you enabled [smooth scrolling](../../config/pointing.md#kconfig) then you will want to use the same `MOVE_UP`, `MOVE_DOWN`, etc values instead of the smaller `SCRL_*` parameters for more sensible scroll speeds.
 
 :::