Commit graph

926 commits

Author SHA1 Message Date
Rasmus Koit
900ff1f4c1
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-18 15:47:39 +03:00
Rasmus Koit
c64642fb9b
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-18 15:46:20 +03:00
Rasmus Koit
d72ae980d0
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-18 15:46:09 +03:00
Rasmus Koit
f06f261128
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-18 15:45:55 +03:00
Rasmus Koit
61b0203116
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-18 15:45:34 +03:00
rasmuskoit
aa89b74b47
rephrase from us to you
some restructure to cfg files
2024-08-11 23:01:06 +03:00
Rasmus Koit
7fea1a756a
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-11 21:35:31 +03:00
Rasmus Koit
e85a34bd39
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-11 21:28:34 +03:00
rasmuskoit
9a94cc77a9
Merge branch 'dongle-doc' of github.com:RasmusKoit/zmk into dongle-doc 2024-08-11 21:20:55 +03:00
Rasmus Koit
a27a553db9
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-11 21:20:32 +03:00
rasmuskoit
d3e821ecee
removes unused picture 2024-08-11 21:18:32 +03:00
Rasmus Koit
c791f9fd9d
Update docs/docs/features/dongle.mdx
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-11 21:18:01 +03:00
rasmuskoit
4da4704e2a
adds a line for split keyboards 2024-08-10 22:47:29 +03:00
rasmuskoit
cf74b624dd
squash after rebase 2024-08-10 16:22:45 +03:00
rasmuskoit
afe40027a4
rename from splits to dongle 2024-08-10 16:15:57 +03:00
rasmuskoit
21bb47d82d
Removes section for dongle.conf 2024-08-10 16:15:57 +03:00
rasmuskoit
439c045483
Improves benefits/disadvantages section.
Make the documentation more specific to dongles.
Moves some of the configuration around.
Adds an option for building firmware with left as central.
Clarifies different MCU usages.
Normalizes file names.
Removes duplicate warning.
2024-08-10 16:15:57 +03:00
rasmuskoit
997fc9f75b
removes svg, adds png 2024-08-10 16:15:56 +03:00
rasmuskoit
877d654f0d
adds clarifing comments about microcontrollers setup
adds a nice picture
2024-08-10 16:15:56 +03:00
rasmuskoit
6e622eba37
Fixes a typo in reset link 2024-08-10 16:15:56 +03:00
rasmuskoit
8ca4971189
Adds a section about building the firmware 2024-08-10 16:15:55 +03:00
rasmuskoit
f5ff4e32d9
Tests commenting out documentation 2024-08-10 16:15:55 +03:00
rasmuskoit
26f3c7c6c4
Adds link to further explain reset behavior on splits kbs 2024-08-10 16:15:55 +03:00
rasmuskoit
8c9533071f
adds tailend of a warning 2024-08-10 16:15:54 +03:00
rasmuskoit
89d47f18f9
Adds a mermaid diagram explaining the connection. Add explanation about reset behavior 2024-08-10 16:15:54 +03:00
rasmuskoit
e5c19a15ec
Adds initial draft version of splits and dongle 2024-08-10 16:15:54 +03:00
Cem Aksoylar
2eff266f5b feat(docs): Add battery life remark for split keyboards 2024-08-07 23:57:58 -07:00
Cem Aksoylar
2a0708d1fc feat(docs): Add locality warning for nested behaviors 2024-08-07 23:57:58 -07:00
Cem Aksoylar
2501f1f548 feat(docs): Add references to new split keyboards page 2024-08-07 23:57:58 -07:00
Cem Aksoylar
d75e388593 feat(docs): Add split keyboards feature page
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-07 23:57:58 -07:00
Cem Aksoylar
47a6715aa6 fix(docs): Fix toggle layer docs 2024-08-02 11:17:10 -07:00
Cem Aksoylar
b9a025c76e
fix(docs): Document number of peripherals Kconfig (#2389)
Fixes #2373
2024-08-02 18:57:15 +02:00
Cem Aksoylar
b080befebb fix(docs): Fix link for matrix transform 2024-08-02 09:55:20 -07:00
Nicolas Munnich
9e7fcde868
feat(docs): Improve the layers-related documentation (#2390)
Fixes #1284
2024-07-31 20:53:36 -07:00
Nicolas Munnich
f92dce43e9
feat(docs): Add modules feature page (#2380)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-07-25 12:08:08 -07:00
Nicolas Munnich
fd152baff0
feat(docs): Add troubleshooting notes on experimental bluetooth options (#2387)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-07-25 12:00:22 -07:00
Cem Aksoylar
7bd74a6b0f fix(docs): Add required display-name in physical layout examples 2024-07-14 16:59:15 -07:00
Peter Johanson
b4f9081b09 docs: Updated new shield documentation for physical layouts.
* Document how to define one or more physical layouts and assign
  the chosen one.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-07-03 16:52:05 -06:00
Peter Johanson
0438cb0ee5 feat(kscan): More complete PM support to drivers.
* Update our GPIO kscan drivers to more completely support PM device,
  by doing proper hardare init/deinit in the PM action hook.
2024-07-03 16:52:05 -06:00
Timoyoungster
29599e8b0a docs: hopefully more clear description of the new setting 2024-06-24 14:26:14 -06:00
Timoyoungster
10d03ca46c fix: adding option to separate implicit mod release from key release
This adds a new config value `ZMK_HID_SEPARATE_MOD_RELEASE_REPORT`
where, if enabled, the report for a key release is sent separately to
the accompanying modifier release signals, which are then sent in a
second report.

This fixes an issue where certain applications are unable to work with
implicitly modified keys (e.g. colon) due to them registering the
modifier release prior to the actual key release.

Have tested this on my personal keyboard and `wev` now shows the signals
in the correct order.

=> **Previously:** ```LSHIFT (pressed) -> colon (pressed) -> LSHIFT
(released) -> **semi**colon (released)```

=> **Now:** ```LSHIFT (pressed) -> colon (pressed) -> colon (released)
-> LSHIFT (released)```

(This time without accidental files)
2024-06-24 14:26:14 -06:00
honorless
4dce096161 docs: improve settings_reset link 2024-06-24 13:18:56 -07:00
Peter Johanson
a080b5287f refactor: Remove static CDC ACM logging nodes.
* To avoid spurious CDC ACM instances when usint CDC ACM for something
  other than logging, move to the approach used by Zephyr of using a
  snippet to redirect console output to a CDC ACM node added by the
  snippet. Remove all the existing static CDC ACM nodes.
* Add new `zmk-usb-logging` snippet that mirrors the upstream
  `cdc-acm-logging` snippet, but still does our extra USB logging
  configuration.
* Updated logging docs accordingly.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-06-20 12:06:13 -06:00
Cem Aksoylar
7c09eb217e refactor(docs): Document and enforce header casing conventions 2024-06-17 11:46:32 -07:00
Cem Aksoylar
e56db304ea refactor(docs): Split up troubleshooting page into a section 2024-06-17 11:46:32 -07:00
Nicolas Munnich
308d6bce6e
feat(docs): Improve the toolchain setup page (#2272)
Split the toolchain setup into separate docker and native pages
and improve instructions to better refer to Zephyr docs in certain steps.
Also refactor to improve consistency and add virtualenv instructions.

---------

Co-authored-by: KemoNine <mcrosson@kemonine.info>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-06-01 21:51:08 -07:00
Nicolas Munnich
2d96f469c8
fix(docs): Removing to-to typos (#2310) 2024-05-25 22:16:33 -07:00
Horu
7d1f84e3eb
chore: fix typos in various places 2024-05-13 16:47:33 -04:00
ReFil
4dfc45d4ab
feat(docs): Document example toggle-mode implementation
---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-05-03 14:17:09 -04:00
Cem Aksoylar
a9021deef6 fix(docs): Add wakeup-source to split new shield example 2024-04-09 16:27:27 -07:00