kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2171 commits 18 branches 0 tags 93 MiB
Commit graph

31 commits

Author SHA1 Message Date
Cem Aksoylar
2554b5c88f fix(docs): Update boards in build examples to common+uf2 ones 2023-11-13 12:34:44 -08:00
Peter Johanson
8d09809ef0 fix(docs): Updated encoder config docs. 
* Update new shield guide for new sensor/encoder settings.
* Add DTS section to encoder config docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-11-03 12:35:25 -07: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
Cem Aksoylar
791711b555 feat(docs): Note how to use GPIO outside interconnect definition 2023-10-08 18:38:48 -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
Peter Johanson
c23443a086 feat(docs): Generate new shield interconnect docs. 
* Add to metadata schema for interconnects.
* New conventional location for pinout diagrams/pics.
* New component to generate the tabs for the new shield
  doc section on interconnects.
* Add XIAO and arduino uno pinout diagram.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-12-23 02:41:35 -06:00
as29
11ca0098a5
fix(docs): Disable encoders in dtsi (#1600) 2022-12-20 20:24:32 +00:00
Kyle McCreery
70aa4fa824
feat(boards): Add PillBug board, blackpill interconnect. 
* Add blackbill interconnect metadata.
* Add config/overlay for upstream blackpill boards to work with ZMK.
* Add pillbug board.
* Updated new shield docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-12-10 22:01:37 -06:00
byran.tech
b21ddcf79a
fix(docs): added concrete number for Bluetooth advertising name length 
* Update new-shield.md
* Update config docs.
 2022-08-19 10:29:12 -04:00
Cem Aksoylar
851c37e14f fix(docs): Apply suggestions from #722 reviews 2022-07-05 08:42:27 +01:00
Peter Johanson
6539b3ae25 refactor(split): Clean up Kconfig organization. 
* Seperated configs for split role (central/peripheral)
  and transport (BLE only for now).
* Split the configs to align on structure.
 2022-05-29 19:18:09 -04: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
Evan Callicoat
be343674de
docs: Fix typos and inconsistent spellings (#1079) 2022-01-02 10:34:21 +00:00
Nick Winans
e6645882c3 feat(docs): Update documentation to match new Pro Micro nodes 2021-09-25 23:09:21 -04:00
Nick Winans
10870b24bf fix(docs): Update split naming system 2021-09-25 21:17:24 -04:00
Dom H
c52887e236 fix(docs): Remove build.yml from new shield steps 2021-09-22 17:35:08 -04:00
Cem Aksoylar
33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config 2021-09-14 20:51:05 -04:00
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.
 2021-09-11 00:50:36 -04:00
Peter Johanson
f8e88d78c4 docs: Add docs on hardware metadata files. 2021-09-11 00:50:36 -04:00
Nick Winans
d964faaa89 fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
innovaker
47043c86e9 docs: bump Zephyr documentation links to Zephyr v2.5.0 
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-07-17 17:04:25 -04:00
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.
 2021-02-02 01:02:54 -05:00
Aaron Nunley
592b98cd12 npm run prettier:format 2021-02-02 01:02:54 -05:00
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.
 2021-02-02 01:02:54 -05:00
Nick Winans
0c6686f6e8 docs(split): Remove USB configuration on right half 2021-01-08 16:51:50 -05:00
Nick Winans
a470353760 docs(shield): Add docs based on #510 changes 2021-01-04 14:08:00 -05:00
Pete Johanson
74b397ab91 fix(docs): Add closing bracket for new shield. 2021-01-04 11:59:25 -05:00
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
 2021-01-04 00:13:49 +00:00
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
 2020-12-28 01:15:35 -05:00
innovaker
2744f44e73 refactor(docs): Integrate Dev Guides into Development section 
Improves discoverability.
 2020-11-20 22:31:56 -05:00
Renamed from docs/docs/development/guide-new-shield.md (Browse further)