kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2522 commits 18 branches 0 tags 93 MiB
Commit graph

665 commits

Author SHA1 Message Date
Peter Johanson
30e9accc95 feat(docs): Wait options for matrix driver. 
* Document `CONFIG_ZMK_KSCAN_MATRIX_WAIT_BETWEEN_OUTPUTS` and
  `CONFIG_ZMK_KSCAN_MATRIX_WAIT_BEFORE_INPUTS` options
 2022-09-29 01:06:54 -04:00
Kurtis Lew
8976b353ae fix(docs): Correct mo_tog implementation in tabbed menu 2022-09-25 20:06:20 -05:00
David A. Bell
8f67333957 Update docs/docs/behaviors/hold-tap.md 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-09-21 23:44:09 -05:00
David A. Bell
9756a16306 fix(docs): Consistent naming in Mo-Tog example. 
Updated all references in example to conform to Hold action-Tap action wording order.
 2022-09-21 23:44:09 -05:00
David A. Bell
597a48ff2d Update hold-tap.md 
The bindings for the toggle-layer-on-tap/momentary-layer-on-hold example code were backwards, resulting in toggle-on-hold. This also made momentary unachievable.
 2022-09-21 23:44:09 -05:00
Robert U
3f28a55452
fix(docs): Fix ambiguous tap-preferred desc. 2022-09-11 21:06:04 -04:00
byran.tech
b21ddcf79a
fix(docs): added concrete number for Bluetooth advertising name length 
* Update new-shield.md
* Update config docs.
 2022-08-19 10:29:12 -04:00
Anton
f238001904
doc(keymaps): fix typo (#1425) 2022-08-12 07:37:06 -04:00
Kurtis Lew
eee7e1cd41
fix(docs): Update tap-dance and hold-tap documentation 
Co-Authored-By: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-07-30 10:24:49 +01:00
byran.tech
8bc96ab9fe
feat(docs): added "how is the latency" 
* Update docs/docs/faq.md

Co-authored-by: Kurtis Lew <kurtis.a.lew@gmail.com>
Co-authored-by: Dom H <dom@hxy.io>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
 2022-07-27 09:07:57 -04:00
HanfG
01f51f06dc
fix(docs): Fix col/row properties in kscan.md example 2022-07-27 08:17:40 -04:00
Nick Coutsos
70beff7e62
refactor(docs): Change wording in RGB_COLOR_HSB description 
Simplify description for second &rgb_ug parameter
 2022-07-27 08:15:46 -04:00
byran.tech
54aa3e6a1e
fix(docs): typo fixes 
* Update user-setup.md
 2022-07-25 23:43:56 -04:00
GreenAirplane
f68692effd
feat(docs): Document behavior queue limit for Macros (#1384) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
 2022-07-20 16:17:19 +01:00
byran.tech
b1ce8a0d33
fix(docs): typo fixes 2022-07-12 08:47:19 +01:00
Cem Aksoylar
41c9d81096 fix(docs): Update config docs for split Kconfig refactor 2022-07-05 08:42:27 +01:00
Cem Aksoylar
19d8c5ba40 feat(docs): Document new underglow Kconfig 2022-07-05 08:42:27 +01:00
Cem Aksoylar
851c37e14f fix(docs): Apply suggestions from #722 reviews 2022-07-05 08:42:27 +01:00
Joel Spadin
ae78aa247a feat(docs): Update power and lighting config pages 
Moved battery configuration to its own page to match the feature page.

Documented that external power is disabled when in sleep mode.

Clarified that the *_START configs apply on first boot, and any changes
after that are persisted.
 2022-07-03 18:55:54 +01:00
Joel Spadin
1646cd7f30 feat(docs): Add a simpler matrix transform example 2022-07-03 18:55:54 +01:00
Joel Spadin
6e67e4a3a5 feat(docs): Update direct GPIO configuration 2022-07-03 18:55:54 +01:00
Joel Spadin
74b4933980 feat(docs): Clarify descriptions of config files 2022-07-03 18:55:54 +01:00
Joel Spadin
e0e0928f9c fix(docs): Update config docs for review feedback 2022-07-03 18:55:54 +01:00
Joel Spadin
01ffea1b47 feat(docs): Update configuration overview 2022-07-03 18:55:54 +01:00
Joel Spadin
c350f7130b fix(docs): Fix links in config pages 2022-07-03 18:55:54 +01:00
Joel Spadin
2b122acfc3 feat(docs): Updating lighting config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
e8e6b2a333 feat(docs): Update general system config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
e46eaf5617 feat(docs): Update power config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
71b8f9d4ac feat(docs): Update display config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
bf84481b47 feat(docs): Update behavior config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
d36792db2d feat(docs): Update kscan config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
11861a4d30 docs: Add documentation for config options 2022-07-03 18:55:54 +01:00
Cem Aksoylar
91de215bf0 fix(docs): Add missing underglow on/off defines 2022-07-03 13:30:25 +01:00
Kurtis Lew
edc60e5848 fix(docs): Update keycode usage ID for numeric 4 in key-press.md 
Co-Authored-By: Robert U <978080+urob@users.noreply.github.com>
 2022-06-20 23:27:57 -04:00
Peter Johanson
1e8224c296 feat(behaviors): Add DEL/BSPC to continue list. 
* Continue caps word on delete/backspace by
  default now.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-06-04 01:38:42 -04:00
Caleb Goates
0977be622a feat(docs): Add docs for key toggle behavior 2022-06-03 00:04:41 -04:00
Yomi Ikuru
6150ad65c4
feat(docs): Add tip for improving build times 2022-05-31 21:32:13 +01:00
Peter Johanson
6539b3ae25 refactor(split): Clean up Kconfig organization. 
* Seperated configs for split role (central/peripheral)
  and transport (BLE only for now).
* Split the configs to align on structure.
 2022-05-29 19:18:09 -04:00
Kurtis Lew
8a70d5fccc
feat(docs): Add New Behavior Guide 
Co-authored-by: Henré Botha <henrebotha@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
 2022-05-21 17:26:10 +01:00
Peter Johanson
64dadfb336 refactor(tests): Move remaining tests to posix 64. 
* Update docs and fix up a few lingering tests
  to consistently use native_posix_64 target.
 2022-05-19 10:55:23 -04:00
Kurtis Lew
8bbbf530a7 fix(docs): Remove code-snippet backticks from customization.md title 
Discussed here: https://discord.com/channels/719497620560543766/883452966114324550/970385441134104747

Code snippets in titles are not formatted properly in page titles
 2022-05-01 21:14:19 +01:00
Joel Spadin
d7b912b798 fix(docs): Fix broken links in FAQs 2022-04-30 09:34:30 +01:00
Dom H
e5843b268c fix(docs): Clarify timeout-ms for Combos 2022-04-29 14:13:04 -04:00
Andrew Rae
b5efc7a7eb
feat(behaviors): Add global-quick-tap 2022-04-27 13:33:22 +01:00
Xudong Zheng
dffae5cf2b fix(docs): Correct default Mod-Tap behavior 2022-04-26 18:49:15 +01:00
Kurtis Lew
2a38849f4e fix(docs): Fix link to BT_CTLR_TX_PWR adjustment in Zephyr docs 2022-04-25 19:59:20 +01:00
Thomas de Barochez
a24cc5d688 doc(backlight): small typo 2022-04-21 18:42:54 -05:00
Peter Johanson
c8c273d83b feat(docs): Add TOC to supported hardware page. 2022-04-19 07:05:26 -04:00
Dom H
6308ab9426 fix(docs): Ensure relative links always resolve 
Linking to the document _file path_ rather than the document _URL_
ensures that the link resolves regardless of trailing slash config.

More information is at https://docusaurus.io/docs/docs-markdown-features
 2022-04-18 22:48:53 -05:00
Dom H
3e294375b6 feat(docs): Provide current status of Displays 2022-04-18 12:15:49 -04:00