Skip to content

Commit 09524b9

Browse files
committed
feat(docs): Add references to new split keyboards page
1 parent debc42a commit 09524b9

File tree

14 files changed

+16
-18
lines changed

14 files changed

+16
-18
lines changed

docs/docs/behaviors/backlight.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ However the settings will only be saved after [`CONFIG_ZMK_SETTINGS_SAVE_DEBOUNC
5858

5959
## Split Keyboards
6060

61-
Backlight behaviors are global: This means that when triggered, they affect both the central and peripheral side of split keyboards.
61+
Backlight behaviors are [global](../features/split-keyboards.md#global-locality-behaviors): This means that when triggered, they affect both the central and peripheral side of split keyboards.

docs/docs/behaviors/power.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ However it will only be saved after [`CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE`](../con
7070

7171
## Split Keyboards
7272

73-
Power management behaviors are global: This means that when triggered, they affects both the central and peripheral side of split keyboards.
73+
Power management behaviors are [global](../features/split-keyboards.md#global-locality-behaviors): This means that when triggered, they affects both the central and peripheral side of split keyboards.

docs/docs/behaviors/reset.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,4 @@ Example:
4444

4545
## Split Keyboards
4646

47-
Both basic and bootloader reset behaviors are source-specific: This means that it affects the side of the keyboard that contains the behavior binding for split keyboards. For example if you press a key with the `&sys_reset` binding on the left half of the keyboard, the left half will be reset. If you want to be able to reset both sides you can put the bindings on both sides of the keyboard and activate it on the side you would like to reset.
48-
49-
:::note[Peripheral invocation]
50-
The peripheral side of the keyboard has to be paired and connected to the central side in order to be able to activate these behaviors, even if it is possible to trigger the behavior using only keys on that side. This is because the key bindings are processed on the central side which would then instruct the peripheral side to reset.
51-
:::
47+
Both basic and bootloader reset behaviors are [source-specific](../features/split-keyboards.md##source-locality-behaviors): This means that it affects the side of the keyboard that contains the behavior binding for split keyboards. For example if you press a key with the `&sys_reset` binding on the left half of the keyboard, the left half will be reset. If you want to be able to reset both sides you can put the bindings on both sides of the keyboard and activate it on the side you would like to reset.

docs/docs/behaviors/underglow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ However the settings will only be saved after [`CONFIG_ZMK_SETTINGS_SAVE_DEBOUNC
7777

7878
## Split Keyboards
7979

80-
RGB underglow behaviors are global: This means that when triggered, they affect both the central and peripheral side of split keyboards.
80+
RGB underglow behaviors are [global](../features/split-keyboards.md#global-locality-behaviors): This means that when triggered, they affect both the central and peripheral side of split keyboards.

docs/docs/config/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ When building with a `zmk-config` folder, ZMK will search the `zmk-config/config
2424

2525
These files hold your personal settings for the keyboard. All files are optional. If present, they override any configuration set in the board or shield folders. Otherwise, the default configuration and/or keymap is used.
2626

27-
When using a split keyboard, you can use a single file without the `_left` or `_right` suffix to configure both sides. For example, `corne.conf` and `corne.keymap` will apply to both `corne_left` and `corne_right`. If a shared config file exists, any left or right files will be ignored.
27+
When using a [split keyboard](../features/split-keyboards.md), you can use a single file without the `_left` or `_right` suffix to configure both sides. For example, `corne.conf` and `corne.keymap` will apply to both `corne_left` and `corne_right`. If a shared config file exists, any left or right files will be ignored.
2828

2929
### Board Folder
3030

docs/docs/config/system.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Note that `CONFIG_BT_MAX_CONN` and `CONFIG_BT_MAX_PAIRED` should be set to the s
117117

118118
### Split keyboards
119119

120-
Following split keyboard settings are defined in [zmk/app/src/split/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/split/Kconfig) (generic) and [zmk/app/src/split/bluetooth/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/split/bluetooth/Kconfig) (bluetooth).
120+
Following [split keyboard](../features/split-keyboards.md) settings are defined in [zmk/app/src/split/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/split/Kconfig) (generic) and [zmk/app/src/split/bluetooth/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/app/src/split/bluetooth/Kconfig) (bluetooth).
121121

122122
| Config | Type | Description | Default |
123123
| ------------------------------------------------------- | ---- | -------------------------------------------------------------------------- | ------------------------------------------ |

docs/docs/customization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ It is also possible to build firmware locally on your computer by following the
4949

5050
For normal keyboards, follow the same flashing instructions as before to flash your updated firmware.
5151

52-
For split keyboards, only the central (left) side will need to be reflashed if you are just updating your keymap.
52+
For [split keyboards](features/split-keyboards.md#building-and-flashing-firmware), only the central (left) side will need to be reflashed if you are just updating your keymap.
5353
More troubleshooting information for split keyboards can be found [here](troubleshooting/connection-issues.mdx#split-keyboard-halves-unable-to-pair).
5454

5555
## Building Additional Keyboards

docs/docs/development/new-behavior.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
346346
endif()
347347
```
348348

349-
For behaviors that do not require central locality, the following options for updating `app/CmakeLists.txt` also exist:
349+
For behaviors that do not require [central locality](../features/split-keyboards.md#behaviors-with-locality), the following options for updating `app/CMakeLists.txt` also exist:
350350

351351
- Behavior applies to unibody, or central or peripheral half of keyboard: place `target_sources(app PRIVATE <behavior_name>.c)` line _before_ `if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)`
352352
- Behavior applies to _only_ central half of split keyboard: place `target_sources(app PRIVATE <behavior_name>.c)` after `if (CONFIG_ZMK_SPLIT AND CONFIG_ZMK_SPLIT_ROLE_CENTRAL)`

docs/docs/development/new-shield.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The high level steps are:
2929
It may be helpful to review the upstream [shields documentation](https://docs.zephyrproject.org/3.5.0/hardware/porting/shields.html#shields) to get a proper understanding of the underlying system before continuing.
3030

3131
:::note
32-
ZMK support for split keyboards requires a few more files than single boards to ensure proper connectivity between the central and peripheral units. Check the following guides thoroughly to ensure that all the files are in place.
32+
ZMK support for [split keyboards](../features/split-keyboards.md) requires a few more files than single boards to ensure proper connectivity between the central and peripheral units. Check the following guides thoroughly to ensure that all the files are in place.
3333
:::
3434

3535
## New Zephyr Module Repository

docs/docs/features/battery.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Battery Level
55

66
If your keyboard has a battery sensor, ZMK will report its battery level to the connected bluetooth host and show it on the keyboard's display, if it has one.
77

8-
For split keyboards, only the battery level of the central (usually left) side is reported over bluetooth by default. ZMK can be [configured to report the battery levels for peripherals](../config/battery.md#peripheral-battery-monitoring), but not many host systems will display this information without additional configuration or the use of third party utilities.
8+
For [split keyboards](split-keyboards.md), only the battery level of the central (usually left) side is reported over bluetooth by default. ZMK can be [configured to report the battery levels for peripherals](../config/battery.md#peripheral-battery-monitoring), but not many host systems will display this information without additional configuration or the use of third party utilities.
99

1010
:::note
1111

docs/docs/features/bluetooth.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Bluetooth
33
sidebar_label: Bluetooth
44
---
55

6-
ZMK's bluetooth functionality allows users to connect their keyboards to hosts using Bluetooth Low Energy (BLE) technology. It also is used for split keyboards to connect the two halves wirelessly.
6+
ZMK's bluetooth functionality allows users to connect their keyboards to hosts using Bluetooth Low Energy (BLE) technology. It also is used for [split keyboards](split-keyboards.md) to connect the two halves wirelessly.
77

88
:::note
99

docs/docs/features/combos.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Key positions are numbered like the keys in your keymap, starting at 0. So, if t
4545
- You are not limited to `&kp` bindings. You can use all ZMK behaviors there, like `&mo`, `&bt`, `&mt`, `&lt` etc.
4646

4747
:::note[Source-specific behaviors on split keyboards]
48-
Invoking a source-specific behavior such as one of the [reset behaviors](behaviors/reset.md) using a combo will always trigger it on the central side of the keyboard, regardless of the side that the keys corresponding to `key-positions` are on.
48+
Invoking a [source-specific behavior](split-keyboards.md#source-locality-behaviors) such as one of the [reset behaviors](behaviors/reset.md) using a combo will always trigger it on the central side of the keyboard, regardless of the side that the keys corresponding to `key-positions` are on.
4949
:::
5050

51-
See [combo configuration](/docs/config/combos) for advanced configuration options.
51+
See [combo configuration](../config/combos.md) for advanced configuration options.

docs/docs/troubleshooting/connection-issues.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export const Uf2Tabs = (props) => (
2424

2525
## Split Keyboard Halves Unable to Pair
2626

27-
Split keyboard halves will automatically pair with one another, but there are some cases where this breaks, and the pairing needs to be reset, for example:
27+
[Split keyboard](../features/split-keyboards.md) halves will automatically pair with one another, but there are some cases where this breaks, and the pairing needs to be reset, for example:
2828

2929
- Switching which halves are the central/peripheral.
3030
- Replacing the controller for one of the halves.

docs/docs/user-setup.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ connect to it wirelessly.
209209
For split keyboards, only the central half (typically the left side) will send keyboard outputs over USB or advertise to other devices
210210
over bluetooth. Peripheral half will only send keystrokes to the central once they are paired and connected. For this reason it is
211211
recommended to test the left half of a split keyboard first.
212+
Please refer to [split keyboards documentation](features/split-keyboards.md) for more information.
212213

213214
:::
214215

@@ -221,6 +222,7 @@ ZMK supports multiple BLE “profiles”, which allows you to connect to and swi
221222
### Connecting Split Keyboard Halves
222223

223224
For split keyboards, after flashing each half individually you can connect them together by resetting them at the same time. Within a few seconds of resetting, both halves should automatically connect to each other.
225+
Please refer to [the pairing section in the split keyboards documentation](features/split-keyboards.md#pairing-for-wireless-split-keyboards) for more information.
224226

225227
:::note
226228

0 commit comments

Comments
 (0)