Commit Graph

425 Commits

Author SHA1 Message Date
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
Joel Spadin b7b026f20c feat(docs): Add battery sensor documentation 2022-04-17 11:30:57 -04:00
Herald ebc6275a72
fix(docs): Document `ignore-modifiers` and `quick-release` for sticky keys (#1228) 2022-04-14 16:13:33 +01:00
DoctorNefario 0e54603ec6 fix(docs): Clarify backlight & underglow use cases
This should help reduce confusion for newcomers.
2022-04-14 16:03:29 +01:00
Cem Aksoylar 32c8737a22 fix(docs): Fix cmake version requirements 2022-04-08 07:18:44 -04:00
Albert Y 6753d31ee9
docs: Revise "Troubleshooting" for Zephyr 3.0 (#1214)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
2022-04-07 09:26:22 +01:00
Caleb Goates 9c3d909b82 feat(docs): Reference conditional layers from the layers behavior page 2022-04-06 19:11:23 +01:00
Cem Aksoylar 27ba5fdfb3 fix(docs): Improve powershell command for setup script for failure cases 2022-04-03 08:39:15 +01:00
Peter Johanson 3c4ff9c82c fix(docs): Proper links to new SDK version. 2022-04-03 00:10:29 -04:00
Peter Johanson bf2fc68070 fix(underglow): Add newly required color-mapping prop. 2022-04-03 00:10:29 -04:00
Kurtis Lew 28ef19488d fix(docs): Fix Number of Profiles note in Bluetooth docs
Remove hard line wrapping
2022-03-31 09:00:47 +01:00
Albert Y 59d2744a4f
feat(docs): Add settings_reset build instructions (#1197)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-03-30 09:56:47 +01:00
Cem Aksoylar 92e7618346 fix(docs): Fix Windows unicode macro example 2022-03-28 21:16:48 -04:00
Albert Y 5f35a0bf58
feat(docs): Add note on locating tmp file in GH actions (#1177)
Co-authored-by: Dom H <dom@hxy.io>
2022-03-28 08:44:34 +01:00
Peter Johanson 34e1de23fb feat(docs): Document the macro behavior. 2022-03-23 23:42:54 -04:00
Kurtis Lew 58c7c0ee0c
feat(docs): Add tap-dance to feature matrix 2022-03-16 11:06:55 -04:00
Kurtis Lew 32ebe2cfb5
feat(behaviors): Add Tap-Dance behavior 2022-03-16 01:08:42 -04:00
Caleb Goates 594cc55e0c fix(docs): Update instructions to find settings reset firmware 2022-03-08 06:21:53 -05:00
Dom H 322cc14da6 fix(docs): Remove trailing whitespace
Otherwise, prettier fails.
2022-02-16 15:29:02 +00:00
chadbailey59 43ffa6c760
docs: Clarifications within New Shield page (#1130)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-02-16 11:46:15 +00:00
Cem Aksoylar 5c4f26ae74 fix(docs): Tweak label of left-hand positional hold-tap example behavior
We see folks copying this behavior node and duplicating it for the right hand,
then forgetting to modify the "label" value and getting confusing runtime
behavior. If we modify the label to be left-specific like this it might be
a better hint to change it when duplicating it.
2022-02-12 07:09:58 +00:00
Cem Aksoylar 22ed448843 fix(docs): Replace deprecated keycode in positional-hold-tap example 2022-02-12 07:09:58 +00:00
Albert Y 7474d985c9
docs: Add guide to build additional keyboards with GH Actions (#1126)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-02-11 10:05:04 +00:00
Cem Aksoylar c18c3d9106 feat(docs): Add note for combos invoking source-specific behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar 76268bae8f feat(docs): Document locality for backlight behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar a1ef7c8090 feat(docs): Document locality for RGB underglow behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar c0b5985ac7 feat(docs): Document locality for power management behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar 5c4bf8a3bb feat(docs): Document locality for reset behaviors 2022-02-07 09:30:16 -05:00
Alessandro Bortolin be94e04963 docs(backlight): improve documentation 2022-02-05 23:40:18 -05:00
Alessandro Bortolin 13a4515300 feat(backlight): add command to cycle brightness 2022-02-05 23:40:18 -05:00
Alessandro Bortolin 2c0fe3934d feat(backlight): add tests 2022-02-05 23:40:18 -05:00
Alessandro Bortolin ce843825e8 refactor(backlight): code cleanup 2022-02-05 23:40:18 -05:00
Alessandro Bortolin da41391b1f feat(docs): add backlight documentation 2022-02-05 23:40:18 -05:00
Peter Johanson 70bb7c9334 feat(behaviors): `&key_repeat` behavior + tests.
* Add new `&key_repeat` behavior that captures and re-sends
  the most recently triggered keycode.

Closes: #853
2022-01-30 22:47:34 -05:00
Albert Y 2ad8f687c0
docs: Add a note for GitHub SSH scheme (#1089)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-01-13 09:23:43 +00:00
Evan Callicoat be343674de
docs: Fix typos and inconsistent spellings (#1079) 2022-01-02 10:34:21 +00:00
Cem Aksoylar ef0d088cb8 feat(docs): Link to outputs page in troubleshooting re: BT output 2021-12-28 21:17:48 +00:00
Cem Aksoylar 8c321063a0 feat(docs): Add note for USB power in outputs page 2021-12-28 21:17:48 +00:00
Ivan Smirnov 3114ce00b9
docs: reiterate building from `zmk/app/` (#1031)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2021-12-28 10:52:16 +00:00
Albert Y a562578fd2
docs: change quick_tap_ms to quick-tap-ms (#1071) 2021-12-28 10:04:18 +00:00
Evan Callicoat 62e3b573b9 Typos 2021-12-26 13:44:46 -06:00