xenua
/
zmk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

fix(docs): Apply suggestions from #722 reviews

xmkb
Cem Aksoylar 2 years ago committed by Julia Luna
parent
8d00dd4582
commit
d4bda0c66f
Signed by: xenua
GPG Key ID: 6A0C04FA9A7D7582
4 changed files with 23 additions and 16 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      docs/docs/config/behaviors.md
  2. 8
      docs/docs/config/kscan.md
  3. 3
      docs/docs/config/system.md
  4. 6
      docs/docs/development/new-shield.md

4
docs/docs/config/behaviors.md
Unescape View File

@ -22,10 +22,10 @@ Definition file: [zmk/app/dts/bindings/behaviors/zmk,behavior-caps-word.yaml](ht
Applies to: `compatible = "zmk,behavior-caps-word"` Applies to: `compatible = "zmk,behavior-caps-word"`
| Property | Type | Description | Default | | Property | Type | Description | Default |
| ---------------- | ------ | ------------------------------------------------------------------ | -------------- | | ---------------- | ------ | ------------------------------------------------------------------ | ------------------------------- |
| `label` | string | Unique label for the node | | | `label` | string | Unique label for the node | |
| `#binding-cells` | int | Must be `<0>` | | | `#binding-cells` | int | Must be `<0>` | |
| `continue-list` | array | List of [key codes](/docs/codes) which do not deactivate caps lock | `<UNDERSCORE>` | | `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>` | | `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). `continue-list` is treated as if it always includes alphanumeric characters (A-Z, 0-9).

8
docs/docs/config/kscan.md
Unescape View File

@ -134,8 +134,8 @@ Definition file: [zmk/app/dts/bindings/zmk,kscan-composite.yaml](https://github.
| Property | Type | Description | Default | | Property | Type | Description | Default |
| -------- | ------ | --------------------------------------------- | ------- | | -------- | ------ | --------------------------------------------- | ------- |
| `label` | string | Unique label for the node | | | `label` | string | Unique label for the node | |
| `rows` | int | The number rows of in the composite matrix | | | `rows` | int | The number of rows in the composite matrix | |
| `cols` | int | The number columns of 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: 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 | | | `label` | string | Unique label for the node | |
| `event-period` | int | Milliseconds between each generated event | | | `event-period` | int | Milliseconds between each generated event | |
| `events` | array | List of key events to simulate | | | `events` | array | List of key events to simulate | |
| `rows` | int | The number rows of in the composite matrix | | | `rows` | int | The number of rows in the composite matrix | |
| `cols` | int | The number columns of 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 | | `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). 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).

3
docs/docs/config/system.md
Unescape View File

@ -14,11 +14,12 @@ Definition file: [zmk/app/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/
### General ### General
| Config | Type | Description | Default | | Config | Type | Description | Default |
| ----------------------------------- | ------ | ----------------------------------------------------------------------------- | ------- | | ------------------------------------ | ------ | ----------------------------------------------------------------------------- | ------- |
| `CONFIG_ZMK_KEYBOARD_NAME` | string | The name of the keyboard | | | `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_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_ZMK_WPM` | bool | Enable calculating words per minute | n |
| `CONFIG_HEAP_MEM_POOL_SIZE` | int | Size of the heap memory pool | 8192 | | `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 ### HID

6
docs/docs/development/new-shield.md
Unescape View File

@ -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>
<TabItem value="split"> <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) ### .conf files (Split Shields)
While unibody boards only have one .conf file that applies configuration characteristics to the entire keyboard, 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. - `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. - 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 ## 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: 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:

Write Preview
Loading…
Cancel
Save