Cem Aksoylar
e56db304ea
refactor(docs): Split up troubleshooting page into a section
2024-06-17 11:46:32 -07:00
Nicolas Munnich
2d96f469c8
fix(docs): Removing to-to typos ( #2310 )
2024-05-25 22:16:33 -07:00
Peter Johanson
e66f068fb5
fix(docs): Minor soft-off docs tweaks from review.
2024-03-27 20:59:26 -07:00
Peter Johanson
d0e0ecb4e3
refactor: Use kscan directly to wake when we can.
...
* When adding a dedicated GPIO pin for soft off/on, use the direct
kscan as the waker, instead of adding an additional node.
2024-03-27 20:59:26 -07:00
Pete Johanson
fa9ea9ea8b
fix(docs): Fix soft off waker prop name, headers.
...
* Use the correct property for extra GPIOs to
make active for the waker before going into soft
off state.
* Change header depth for easier navigation of the
soft off feature page.
Co-authored-by: Pablo Martínez <58857054+elpekenin@users.noreply.github.com >
2024-03-27 20:59:26 -07:00
Peter Johanson
cac999b1d6
feat: Updated soft-off docs.
...
* Document new sideband behavior kscan driver for integrated
soft-off support.
2024-03-27 20:59:26 -07:00
Pete Johanson
933fdcd364
refactor(pm): Remove scanned behavior trigger.
...
* Remove the painful scanned behavior trigger for now, future enhancement
will restore this high level functionality using kscan directly.
2024-03-27 20:59:26 -07:00
Peter Johanson
fceb0351a5
refactor: Fixes for soft-off based on review.
...
* Better naming for gpio-key behavior triggers.
* Tweaks to scanned behavior trigger to avoid bad semaphore use,
and reduce chance of issues with slowly scanned matrixes.
* Various code cleanups of style issues.
2024-03-27 20:59:26 -07:00
Pete Johanson
96968514e3
fix(docs): Apply suggestions from code review
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2024-03-27 20:59:26 -07:00
Peter Johanson
adb3a13dc5
feat: Add soft on/off support.
...
Initial work on a soft on/off support for ZMK. Triggering soft off
puts the device into deep sleep with only a specific GPIO pin
configured to wake the device, avoiding waking from other key
presses in the matrix like the normal deep sleep.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2024-03-27 20:59:26 -07:00
Cem Aksoylar
c684cee76f
refactor(docs): Refer to overview page for behaviors
2024-03-24 18:29:29 -07:00
Cem Aksoylar
931a36ff4a
feat(docs): Add a note on using BT with dual boot systems
2024-03-20 11:49:23 -07:00
Cem Aksoylar
aa6cfe250d
feat(docs): Document refreshing the HID descriptor
2024-03-18 09:58:16 -07:00
Cem Aksoylar
bddee70b6b
refactor(docs): Remove outdated Windows battery advice and unnecessary header
2024-03-18 09:58:16 -07:00
Dennis
604af2ebd3
feat(docs): Add pointers for peripheral battery monitoring ( #2177 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
Fixes #2166
2024-02-17 21:51:09 -08:00
Peter Johanson
edc72c1166
chore(docs): Update Zephyr links to 3.5.0 versions.
2024-02-09 14:32:46 -08:00
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