fix(docs): Apply suggestions from zmkfirmware#722 reviews

fsargent · Jul 11, 2022 · 216a30d · 216a30d
1 parent bc8b090
commit 216a30d
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 16 deletions.
diff --git a/docs/docs/config/behaviors.md b/docs/docs/config/behaviors.md
@@ -21,12 +21,12 @@ Definition file: [zmk/app/dts/bindings/behaviors/zmk,behavior-caps-word.yaml](ht
 
 Applies to: `compatible = "zmk,behavior-caps-word"`
 
-| Property         | Type   | Description                                                        | Default        |
-| ---------------- | ------ | ------------------------------------------------------------------ | -------------- |
-| `label`          | string | Unique label for the node                                          |                |
-| `#binding-cells` | int    | Must be `<0>`                                                      |                |
-| `continue-list`  | array  | List of [key codes](/docs/codes) which do not deactivate caps lock | `<UNDERSCORE>` |
-| `mods`           | int    | A bit field of modifiers to apply                                  | `<MOD_LSFT>`   |
+| Property         | Type   | Description                                                        | Default                         |
+| ---------------- | ------ | ------------------------------------------------------------------ | ------------------------------- |
+| `label`          | string | Unique label for the node                                          |                                 |
+| `#binding-cells` | int    | Must be `<0>`                                                      |                                 |
+| `continue-list`  | array  | List of [key codes](/docs/codes) which do not deactivate caps lock | `<UNDERSCORE BACKSPACE DELETE>` |
+| `mods`           | int    | A bit field of modifiers to apply                                  | `<MOD_LSFT>`                    |
 
 `continue-list` is treated as if it always includes alphanumeric characters (A-Z, 0-9).
 

diff --git a/docs/docs/config/kscan.md b/docs/docs/config/kscan.md
@@ -134,8 +134,8 @@ Definition file: [zmk/app/dts/bindings/zmk,kscan-composite.yaml](https://github.
 | Property | Type   | Description                                   | Default |
 | -------- | ------ | --------------------------------------------- | ------- |
 | `label`  | string | Unique label for the node                     |         |
-| `rows`   | int    | The number rows of in the composite matrix    |         |
-| `cols`   | int    | The number columns of in the composite matrix |         |
+| `rows`   | int    | The number of rows in the composite matrix    |         |
+| `cols`   | int    | The number of columns in the composite matrix |         |
 
 The `zmk,kscan-composite` node should have one child node per keyboard scan driver that should be composited. Each child node can have the following properties:
 
@@ -249,8 +249,8 @@ Definition file: [zmk/app/dts/bindings/zmk,kscan-mock.yaml](https://github.com/z
 | `label`        | string | Unique label for the node                     |         |
 | `event-period` | int    | Milliseconds between each generated event     |         |
 | `events`       | array  | List of key events to simulate                |         |
-| `rows`         | int    | The number rows of in the composite matrix    |         |
-| `cols`         | int    | The number columns of in the composite matrix |         |
+| `rows`         | int    | The number of rows in the composite matrix    |         |
+| `cols`         | int    | The number of columns in the composite matrix |         |
 | `exit-after`   | bool   | Exit the program after running all events     | false   |
 
 The `events` array should be defined using the macros from [dt-bindings/zmk/kscan_mock.h](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/kscan_mock.h).

diff --git a/docs/docs/config/system.md b/docs/docs/config/system.md
@@ -13,12 +13,13 @@ Definition file: [zmk/app/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/
 
 ### General
 
-| Config                              | Type   | Description                                                                   | Default |
-| ----------------------------------- | ------ | ----------------------------------------------------------------------------- | ------- |
-| `CONFIG_ZMK_KEYBOARD_NAME`          | string | The name of the keyboard                                                      |         |
-| `CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE` | int    | Milliseconds to wait after a setting change before writing it to flash memory | 60000   |
-| `CONFIG_ZMK_WPM`                    | bool   | Enable calculating words per minute                                           | n       |
-| `CONFIG_HEAP_MEM_POOL_SIZE`         | int    | Size of the heap memory pool                                                  | 8192    |
+| Config                               | Type   | Description                                                                   | Default |
+| ------------------------------------ | ------ | ----------------------------------------------------------------------------- | ------- |
+| `CONFIG_ZMK_KEYBOARD_NAME`           | string | The name of the keyboard                                                      |         |
+| `CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE`  | int    | Milliseconds to wait after a setting change before writing it to flash memory | 60000   |
+| `CONFIG_ZMK_WPM`                     | bool   | Enable calculating words per minute                                           | n       |
+| `CONFIG_HEAP_MEM_POOL_SIZE`          | int    | Size of the heap memory pool                                                  | 8192    |
+| `CONFIG_ZMK_BATTERY_REPORT_INTERVAL` | int    | Battery level report interval in seconds                                      | 60      |
 
 ### HID
 

diff --git a/docs/docs/development/new-shield.md b/docs/docs/development/new-shield.md
@@ -157,6 +157,8 @@ this might look something like:
 };
 ```
 
+See the [Keyboard Scan configuration documentation](../config/kscan.md) for details on configuring the KSCAN driver.
+
 </TabItem>
 
 <TabItem value="split">
@@ -260,6 +262,8 @@ This is exemplified with the iris .overlay files.
 
 ```
 
+See the [Keyboard Scan configuration documentation](../config/kscan.md) for details on configuring the KSCAN driver.
+
 ### .conf files (Split Shields)
 
 While unibody boards only have one .conf file that applies configuration characteristics to the entire keyboard,
@@ -341,6 +345,8 @@ Some important things to note:
 - `RC(row, column)` is placed sequentially to define what row and column values that position corresponds to.
 - If you have a keyboard with options for `2u` keys in certain positions, or break away portions, it is a good idea to set the chosen `zmk,matrix_transform` to the default arrangement, and include _other_ possible matrix transform nodes in the devicetree that users can select in their user config by overriding the chosen node.
 
+See the [matrix transform section](../config/kscan.md#matrix-transform) in the Keyboard Scan configuration documentation for details and more examples of matrix transforms.
+
 ## Default Keymap
 
 Each keyboard should provide an OOTB default keymap to be used when building the firmware, which can be overridden and customized by user configs. For "shield keyboards", this should be placed in the `app/boards/shields/<shield_name>/<shield_name>.keymap` file. The keymap is configured as an additional devicetree overlay that includes the following: