kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Finish documentation section

Browse source
This commit is contained in:
Cem Aksoylar 2023-09-18 23:55:15 -07:00
parent fb004dd1f4
commit 5bed3de677
1 changed files with 20 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/blog/2023-09-15-zmk-sotf-6.md
View file

@ -120,17 +120,31 @@ Check out the [dedicated blog post](2023-04-06-zephyr-3-2.md) for more details!
### Documentation
Configuration options [#722](https://github.com/zmkfirmware/zmk/pull/722)
#### Configuration docs
New behavior guide [#1268](https://github.com/zmkfirmware/zmk/pull/1268)
[joelspadin], through a massive amount of work in [#722](https://github.com/zmkfirmware/zmk/pull/722), contributed a whole new section to the documentation: [configuration](../docs/config/index.md)! It enumerates the configuration options for each ZMK feature that might be relevant to users in dedicated pages, making it a very handy reference.
Tap dance and hold-tap documentation improvements [#1298](https://github.com/zmkfirmware/zmk/pull/1298)
In addition, the [overview page](../docs/config/index.md) presents an overview of how configuration works in Zephyr in the context of ZMK, in terms of devicetree files (like the keymap files or shield overlays), and Kconfig ones (like the `.conf` files). It is very helpful in de-mystifying what the various files do and what syntax is expected in them.
Battery sensor documentation [#868](https://github.com/zmkfirmware/zmk/pull/868)
#### New behavior guide
New shield docs for other interconnects including Xiao, Arduino Uno and Blackpill [#1607](https://github.com/zmkfirmware/zmk/pull/1607)
For any users or future contributors that might want to dive into writing their own ZMK behaviors, [kurtis-lew] wrote a useful [guide on how to create new behaviors](../docs/development/new-behavior.md) in [#1268](https://github.com/zmkfirmware/zmk/pull/1268).
A new Bluetooth feature page [#1499](https://github.com/zmkfirmware/zmk/pull/1499)
#### Tap dance and hold-tap documentation improvements
[kurtis-lew] also improved the documentation for these two behaviors in [#1298](https://github.com/zmkfirmware/zmk/pull/1298), by updating the diagrams to better clarify how their timings work and adding examples for scenarios that are frequently asked by users.
#### Battery sensor documentation
[joelspadin] also added documentation for setting up battery sensors, typically required for new boards, in [#868](https://github.com/zmkfirmware/zmk/pull/868).
#### Shield interconnects
[petejohanson] updated the [new shield guide](../docs/development/new-shield.md) for non-Pro Micro interconnects including Xiao, Arduino Uno and Blackpill in [#1607](https://github.com/zmkfirmware/zmk/pull/1607).
#### Bluetooth feature page
[petejohanson] and [caksoylar] added a new [Bluetooth feature page](../docs/features/bluetooth.md) as part of [#1499](https://github.com/zmkfirmware/zmk/pull/1499) and in [#1818](https://github.com/zmkfirmware/zmk/pull/1499), detailing ZMK's Bluetooth implementation and troubleshooting for common problems.
In addition to the specific contributions listed above, various improvements and fixes to documentation are made by many users from the community, including but not limited to [kurtis-lew], [joelspadin], [filterpaper], [byran.tech], [dxmh] and [caksoylar]. These contributions are are all very appreciated!