zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,311 Commits 30 Branches 7 Tags 112 MiB
Commit Graph

63 Commits

Author SHA1 Message Date
Cem Aksoylar 5cbffd6625 fix(docs): Work around docusaurus bug causing broken links 
Some links ended up broken after docusaurus 3 upgrade,
especially if they are the second on the same line and have anchors.
Likely due to https://github.com/facebook/docusaurus/issues/9518
 2024-01-20 22:28:41 -08:00
Cem Aksoylar dcfe07d9f6 refactor(docs): Use new admonition title syntax and disable mdx v1 compat 2024-01-20 22:28:41 -08:00
Cem Aksoylar f014eb45a7 refactor(docs): Use .mdx for docs with mdx features 
Also applies prettier changes in touched files due to precommit
 2024-01-20 22:28:41 -08:00
Cem Aksoylar a0a952413a fix(docs): Fix deprecated admonition types 2024-01-20 22:28:41 -08:00
Cem Aksoylar 13c856d1d3 fix(docs): Fix mdx 3 incompatibility 2024-01-20 22:28:41 -08:00
Joel Spadin 5ecd3521f5 docs: Remove label property from documentation 2023-12-04 20:06:54 -06:00
ReFil ecefd6d24b
fix(docs): Update backlight docs (#1894) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
 2023-12-04 09:21:49 -08:00
Cem Aksoylar 7b4b5d4ff2 fix(docs): Fix debouncing driver support note 2023-11-13 12:37:09 -08:00
Joel Spadin 65667b863a docs: Add syntax highlighting to more code blocks 
Added language tags to more code blocks in the documentation to enable
syntax highlighting.
 2023-10-09 15:19:24 -07:00
Andrew Rae b85ffa4b6c refactor(behaviors): global-quick-tap -> require-prior-idle 
Renaming global-quick-tap-ms to require-prior-idle.
 2023-10-03 01:12:47 -07:00
Andrew Rae 49c393e8f8 refactor(docs): Applying suggestions for gqt from @caksoylar 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-10-03 01:12:47 -07:00
Andrew Rae 1e84e265b1 feat(docs): Adding global-quick-tap-ms docs 2023-10-03 01:12:47 -07:00
Peter Johanson dcb1f8f135 fix(docs): Update docs about split encoder support 2023-08-27 19:52:03 -07:00
Seth Milliken c957348e61 fix(docs): detail overriding the `led_strip` `chain-length` property 
Quite a few people have struggled with setting the correct
`chain-length` for their `led_strip`. For some, this is their first time
needing to change a pre-defined devicetree property, and so they aren't
familiar with the technique. I commonly see folks adding a duplicate of
the entire `*.overlay` file with only the `chain-length` value changed.
Having clear documentation for this specific application of the property
override technique could help forestall these problems, and give those
of us helping out in Discord something to easily reference.
 2023-08-15 11:04:01 +03:00
Cem Aksoylar ace11e327f fix(docs): Fix broken link in BT troubleshooting 2023-06-02 22:07:29 -06:00
Cem Aksoylar 0682bc3aa6 feat(docs): Note split connectivity improvement with TX power 2023-06-02 21:13:27 -06:00
Cem Aksoylar a9ad11f91e refactor(docs): Move BT troubleshooting items to BT page 2023-06-02 21:13:27 -06:00
Cem Aksoylar 4042aea66f feat(docs): Add troubleshooting for Windows issue 2023-06-02 21:13:27 -06:00
Albert Y 48be2eedd0 fix(docs): Update QMK debounce references 2023-05-09 21:40:14 -07:00
Joel Spadin 94061bb916 refactor: Replace tabs with spaces 
Standardized indentation to use spaces with a new pre-commit hook.
 2023-04-24 16:07:04 -07:00
Nick Conway 3db163aa2c feat(behaviors): Add reusable sensor behaviors. 
* Add new sensor behaviors that either take full bindings
  add definition, or accept parameters when bound in the
  keymap.
* Remove existing hard-coded key press sensor behavior
  and instead leverage new generic sensor behaviors to
  achieve the same functionality.

Co-authored-by: nick@conway.dev
 2023-04-21 21:13:31 -07:00
Peter Johanson 374104dec6 fix(underglow): Move to spi3 for underglow bus. 
* Workaround Zephyr bug for Nordic SPI(M) driver after the
  pinctrl refactor by using spi3 peripheral for the SPI bus for
  the WS2812 led_strip driver.
 2023-04-09 14:41:00 -07:00
Peter Johanson 0c5bcf5fe4 feat(docs): Add BLE feature/config pages. 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-04-05 22:55:38 -07:00
Peter Johanson 1493620bf7 refactor(boards): Move to pinctrl. 2023-04-05 22:55:38 -07:00
Anton f238001904
doc(keymaps): fix typo (#1425) 2022-08-12 07:37:06 -04: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 e0e0928f9c fix(docs): Update config docs for review feedback 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 11861a4d30 docs: Add documentation for config options 2022-07-03 18:55:54 +01:00
Dom H e5843b268c fix(docs): Clarify `timeout-ms` for Combos 2022-04-29 14:13:04 -04:00
Thomas de Barochez a24cc5d688 doc(backlight): small typo 2022-04-21 18:42:54 -05: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
DoctorNefario 0e54603ec6 fix(docs): Clarify backlight & underglow use cases 
This should help reduce confusion for newcomers.
 2022-04-14 16:03:29 +01:00
Peter Johanson bf2fc68070 fix(underglow): Add newly required color-mapping prop. 2022-04-03 00:10:29 -04:00
Cem Aksoylar c18c3d9106 feat(docs): Add note for combos invoking source-specific 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 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
Evan Callicoat be343674de
docs: Fix typos and inconsistent spellings (#1079) 2022-01-02 10:34:21 +00:00
Jonathan Rascher cbf6e28e34 docs(conditional-layers): Document feature 2021-11-15 05:49:23 -05:00
Joel Spadin f946dc6893 feat(kscan): Improve matrix debouncing 
Switched the GPIO matrix driver to debouncing using a simple integrator
algorithm. Whenever a key is pressed, we now scan at a rate controlled
by debounce-scan-period-ms (default 1 ms) until all keys are released,
then return to either waiting for an interrupt or polling more slowly.

The timers for key press and release can now be controlled separately,
so debounce-period is deprecated in favor of debounce-press-ms and
debounce-release-ms. Global Kconfig options
ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also
added to make these easier to set.

Added documentation for debouncing options.
 2021-10-26 23:52:13 -04:00
Richard Titmuss 5d2120ad17 fix(docs): Typo EC11_CONFIG 
This should be CONFIG_EC11
 2021-09-24 02:15:56 -04:00
Nick Winans d964faaa89 fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
chad3814 689ba2d171
fix(docs): Fix "All" typo 2021-08-12 00:08:49 -04:00
Joel Spadin 6870fdc604 fix(docs): Appease Prettier 
Fixed code formatting in docs files.
 2021-08-08 13:17:27 -05:00
Peter Johanson 47109641d8 Add warning about peripheral encoders. 2021-08-04 22:25:41 -04:00
Dom H 06a85f944f docs(codes): Refer to LSHIFT instead of LSHFT 
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
 2021-06-08 20:57:40 -04:00