zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Fix up shield board overlays for new board IDs 

Adjust our documentation to properly use the correct qualified board
overlay file names that match our new board conventions.
This commit is contained in:
Peter Johanson 2026-01-31 19:59:29 -07:00
parent f92b154038
commit c84cf8e52b
2 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/development/hardware-integration/lighting/underglow.md
View File

@ -11,7 +11,7 @@ See the documentation page on [pin control](../pinctrl.mdx) for detailed informa
Shields written for boards which support RGB underglow should add a `boards/` folder underneath the shield folder. Inside this `boards/` folder, create a `<board>.overlay` for any of the boards the shield can be used with. Place all hardware-specific configurations in these `.overlay` files.
For example: the `kyria` shield has a [`boards/nice_nano.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nice_nano.overlay) and a [`boards/nrfmicro_13.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nrfmicro_13.overlay), which configure a WS2812 LED strip for the `nice_nano` and `nrfmicro_13` boards respectively.
For example: the `kyria` shield has a [`boards/nice_nano_nrf52840_zmk.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nice_nano_nrf52840_zmk.overlay) and a [`boards/nrfmicro_nrf52840_zmk_1_3_0.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nrfmicro_nrf52840_zmk_1_3_0.overlay), which configure a WS2812 LED strip for the `nice_nano/nrf52840/zmk` and `nrfmicro@1.3.0/nrf52840/zmk` boards respectively.
### nRF52-Based Boards

5
docs/docs/development/hardware-integration/pinctrl.mdx
View File

@ -27,9 +27,8 @@ Pin control is always defined for a _board_, never for a shield:
```plaintext
boards/shields/sofle/
├── boards/
│ ├── nice_nano.overlay
│ ├── nrfmicro_11.overlay
│ └── nrfmicro_13.overlay
│ ├── nice_nano_nrf52840_zmk.overlay
│ ├── nrfmicro_nrf52840_zmk_1_3_0.overlay
└── <sofle shield defining files>
```
Note that you will need to define a separate overlay _for each_ of the boards to be used with the shield.