Commit graph

637 commits

Author SHA1 Message Date
Albert Y
b7d5865e40 feat(docs): additional note on bug fixed in macOS v13.1 2023-02-02 21:23:48 -05:00
Joel Spadin
82ff6d8e85 docs: update dev env setup guide
Renamed the "Basic Setup" page to "Toolchain Setup" to make it clearer
that this is for setting up a development environment for local builds.

Linked to the relevant Zephyr setup documentation instead of duplicating
that information in our guide. This also switches Windows and macOS
setup to using the Zephyr SDK, which is much easier to install.

Updated the command for installing Zephyr's Python dependencies to be
OS specific, as Windows and macOS don't need the --user flag.

Updated the IDE integration page with instructions for determining the
compiler path that work with the latest version of the Zephyr SDK.
2023-01-19 22:25:10 -05:00
Peter Johanson
c23443a086 feat(docs): Generate new shield interconnect docs.
* Add to metadata schema for interconnects.
* New conventional location for pinout diagrams/pics.
* New component to generate the tabs for the new shield
  doc section on interconnects.
* Add XIAO and arduino uno pinout diagram.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-23 02:41:35 -06:00
Cem Aksoylar
d993b03433 feat(docs): Refer to troubleshooting in connecting split halves 2022-12-23 00:20:12 -06:00
Cem Aksoylar
080c47825f feat(docs): Add caution note about split peripheral sides to user setup 2022-12-23 00:20:12 -06:00
Cem Aksoylar
77d60182bf feat(docs): Recommend USB testing and warn about BT pairing in user setup 2022-12-23 00:20:12 -06:00
Joel Spadin
3eb06f137b feat: Add global macro timing configs
Added ZMK_MACRO_DEFAULT_WAIT_MS and ZMK_MACRO_DEFAULT_TAP_MS to set
global defaults for the wait-ms and tap-ms properties of macros.

Also reduced the default timings for macros, since it's been reported
many times that 100 ms is too slow.
2022-12-20 20:34:25 -06:00
as29
11ca0098a5
fix(docs): Disable encoders in dtsi (#1600) 2022-12-20 20:24:32 +00:00
Petrus Claviger
408b87ae7b
fix(docs): Grammatical fixes (#1587)
Co-authored-by: Dom H <dom@hxy.io>
2022-12-14 14:51:46 +00:00
Kyle McCreery
70aa4fa824
feat(boards): Add PillBug board, blackpill interconnect.
* Add blackbill interconnect metadata.
* Add config/overlay for upstream blackpill boards to work with ZMK.
* Add pillbug board.
* Updated new shield docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-10 22:01:37 -06:00
Cem Aksoylar
2a42fe658e feat(docs): Document battery widget percentage Kconfig 2022-12-10 17:08:37 -06:00
Joel Spadin
6ccb5280c9 fix(docs): Pin Zephyr docs links to a version
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-08 01:00:48 -06:00
Joel Spadin
593db85378 feat(boards): Add support for nRF5340 DK
Added overlays to support building for the nRF5340 development kit.

Also added some documentation on how to build and flash ZMK for dual-
chip Bluetooth configurations, with an example for the nRF5340.
2022-12-08 01:00:48 -06:00
Kurtis Lew
001105e318 fix(docs): Correct typo in hold-tap comparison balanced flavor 2022-12-01 20:11:31 +00:00
Nick Coutsos
5cd608cb60 fix(docs): Correct syntax in capsword mods 2022-11-24 19:11:24 -06:00
Michael Anthony
6e7c2a08a2
fix(docs): Update link to Zephyr led docs
* Change Zephyr gpio-leds link to 3.0.0
2022-11-14 16:58:28 -06:00
byran.tech
c7d83fb951
fix(docs): changed MacOS to macOS as per Apple styling 2022-11-09 20:38:08 -06:00
Terence Stenvold
9847a4c5d5
fix(docs): copy error not exclusive to Apple silicon 2022-11-09 14:56:22 -06:00
Albert Y
4e11913127
feat(docs): troubleshooting steps for macOS 13 Finder bug 2022-10-27 21:03:16 -05:00
byran.tech
3f00f14e36
feat(docs): Added a Spelling Error Caution Notice 2022-10-15 14:00:09 -05:00
Robert U
ef2e6e9156
feat(behaviors): Add mod-morph keep-mods
* Update docs for mod-morph
* Add unit tests for mod-morph
* Add keep-mods to DT binding

Co-authored-by: Martin Aumüller <aumuell@reserv.at>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-10-14 20:40:28 -05:00
Nick Winans
3d3c45bc80
feature(shields): Add nice!view
* Use two shield system, nice_view, and nice_view_adapter
* Build system fixes for interconnect use.
2022-09-29 21:11:26 -04:00
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