Cem Aksoylar
32c8737a22
fix(docs): Fix cmake version requirements
3 years ago
Peter Johanson
3c4ff9c82c
fix(docs): Proper links to new SDK version.
3 years ago
Dom H
322cc14da6
fix(docs): Remove trailing whitespace
...
Otherwise, prettier fails.
3 years ago
chadbailey59
43ffa6c760
docs: Clarifications within New Shield page ( #1130 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
Alessandro Bortolin
da41391b1f
feat(docs): add backlight documentation
3 years ago
Evan Callicoat
be343674de
docs: Fix typos and inconsistent spellings ( #1079 )
3 years ago
Ivan Smirnov
3114ce00b9
docs: reiterate building from `zmk/app/` ( #1031 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
jmding8
19ee7849f8
feat(behaviors) Required keys for tap-hold behaviors
...
* Add optional `hold-trigger-key-positions` hold-tap configuration
* Leverage configuration for decision making around when to trigger
hold decision in hold-taps.
* Add docs for new configuration.
* Tests for the new config/decision logic.
3 years ago
Jonathan Rascher
96fea949d5
docs(docs): Document up-to-date Node.js repo
...
For example, Debian Bullseye (current stable) packages Node.js version
12, which is too old to build the docs successfully. At least version 14
is required, and version 16 is current. General advice seems to be to
install from the NodeSource repo instead of your distro's repo, so I
added a suggestion to the docs.
3 years ago
Nick Winans
e6645882c3
feat(docs): Update documentation to match new Pro Micro nodes
3 years ago
Nick Winans
10870b24bf
fix(docs): Update split naming system
3 years ago
Dom H
c52887e236
fix(docs): Remove build.yml from new shield steps
3 years ago
Richard Titmuss
d769618b3f
fix(docs): Remove unnecessary security warning for MacOS
...
The security warning applies for downloaded executables. If you are
following the instructions the toolchain is installed with brew and
the security warning does not apply. This is explained in the removed
link.
3 years ago
Cem Aksoylar
33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config
3 years ago
Peter Johanson
7bf68f2a00
refactor(docs): Remove build.yml for new shield.
...
* No longer recommending that all new shields get added to the
build matrix in `build.yml`, so we avoid conflicts.
3 years ago
Peter Johanson
f8e88d78c4
docs: Add docs on hardware metadata files.
3 years ago
Nick Winans
d964faaa89
fix(docs): Standardize all internal links
3 years ago
innovaker
a8c0c76fca
docs(setup): replace `zephyr-west-action` with `zmk-docker`
...
This should've been changed after #481 .
See: https://github.com/zmkfirmware/zmk/pull/481
PR: https://github.com/zmkfirmware/zmk/pull/845
3 years ago
innovaker
47043c86e9
docs: bump Zephyr documentation links to Zephyr v2.5.0
...
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
innovaker
c03046e54a
docs(setup): add `x86_64-linux` to Zephyr SDK setup filename
...
See: zmkfirmware/zmk-docker@b8341e185ab694f7c596b81d03ada34ac76d2f1c
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
innovaker
76979d293a
docs(setup): bump `ZSDK_VERSION` to `0.12.4`
...
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
innovaker
576ce76ad3
docs(setup): fix whitespace in Fedora toolchain install command
...
Aligns Fedora whitespace with Debian.
4 years ago
innovaker
84a5fec458
docs(setup): remove extra slash from Fedora toolchain install command
4 years ago
innovaker
6f3a2529ae
docs(setup): fix whitespace mismatch in host dependencies
...
Replaces spaces with tabs (bzip2).
4 years ago
Ivan Smirnov
bb32005474
fix(docs): Update macos GCC embedded section with brew cmd
...
* Update macos GCC embedded section with brew cmd
Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.
4 years ago
Joel Spadin
24ed1a8eaa
docs(vscode): add more info for compile_commands.json path
4 years ago
Joel Spadin
0955ffef65
docs: Add docs for setting up vscode
...
Added a docs page with tips for setting up VS Code's code completion to work
in ZMK's source files. Info for other IDEs can be added here later as needed.
4 years ago
Aaron Nunley
bcc3d9b5a6
Update build/flash documentation.
...
Updated docs for the build and flash to have similar content to the new board page.
Added a bit about DFU in case someone were searching for that term.
4 years ago
Aaron Nunley
592b98cd12
npm run prettier:format
4 years ago
Aaron Nunley
100d06ae8b
Update docs for testing a new shield.
...
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
4 years ago
KemoNine
1adb2d5f84
feat(docs): add information on how to update the documentation to the docs
4 years ago
Nick Winans
0c6686f6e8
docs(split): Remove USB configuration on right half
4 years ago
Nick Winans
167600f01d
docs(logging): Update documentation on USB logging
4 years ago
Nick Winans
a470353760
docs(shield): Add docs based on #510 changes
4 years ago
Pete Johanson
74b397ab91
fix(docs): Add closing bracket for new shield.
4 years ago
Nick Winans
4ddda7e024
docs(shield): Remove SPLIT_BLE_ROLE_PERIPHERAL
...
Removes CONFIG_ZMK_SPLIT_BLE_ROLE_PERIPHERAL from the new shield docs
See: #510
Refs: 4db5b169bf
4 years ago
innovaker
842aa5a842
refactor: replace filename hyphens with underscores
...
Aligns *.h and *.c to underscore naming convention.
These were kept (with warnings) for backwards compatibility with external boards/shields:
- kscan-mock.h
- matrix-transform.h
They should be removed in the future.
PR: #523
4 years ago
innovaker
8fd9b619a7
docs(setup): bump Zephyr SDK version to 0.11.4
...
Latest stable version. Also used in zmk-docker images.
4 years ago
innovaker
8a529163fc
docs(logging): remove CONFIG_USB_UART_DTR_WAIT
...
This configuration option was removed in Zephyr v2.4.0.
See: zephyrproject-rtos/zephyr#27427
PR: #467
4 years ago
KemoNine
784ddfc620
Add note about cmake 3.19 not working with zephr ; addresses issue #487
4 years ago
KemoNine
f8af592a9c
Update cmake note to be 3.15 which is the current minimum version. This is a re-implementation of GitHub PR 403
4 years ago
Okke Formsma
c067629c83
Create `west test` command to run zmk testsuite.
4 years ago
innovaker
2744f44e73
refactor(docs): Integrate `Dev Guides` into `Development` section
...
Improves discoverability.
4 years ago
innovaker
2d50302a02
refactor(docs): Integrate `USB Logging` into `Development` section
...
Improves discoverability.
4 years ago
innovaker
532c1987b2
refactor(docs): Move `dev-` documents into `/development`
...
Aligns to conventions introduced by newer documentation.
4 years ago