Commit Graph

942 Commits

Author SHA1 Message Date
Cem Aksoylar 022ede9d1e docs: Remove download for settings_reset and note local build 2024-10-08 17:04:36 -07:00
Cem Aksoylar 16976db58c docs: Fix columns names in kscan config 2024-10-08 14:58:04 -07:00
Cem Aksoylar 6e2d30d589 docs: Add missing hold-trigger-on-release to config 2024-10-08 14:58:04 -07:00
Peter Johanson 6cac781ada feat: Add basic metadata info to new behavior guide.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-10-08 00:45:37 -06:00
LostQuasar 90d6285d98
blog: Remove reference to spaceman (#2520) 2024-09-30 19:43:58 -07:00
Nicolas Munnich e195822559 docs: fixed broken anchors 2024-09-30 16:43:47 -07:00
Nicolas Munnich 99b424bb4b
docs: Streamlined the new shield guide (#2515)
* docs: Streamlined the new shield guide

---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-10-01 00:00:55 +02:00
Nicolas Munnich a314128ea8
docs: Pull encoders from new shield guide to its own page (#2510)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-09-30 10:06:00 -07:00
Nicolas Munnich 1f900bfc9c
docs: Added a note on bluetooth profiles under "unable to connect to device" (#2509)
* docs: Added a note on bluetooth profiles under "unable to connect to device"

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-09-26 19:49:13 +02:00
Cem Aksoylar 8166527ea3 fix(docs): Remove split locality issue note 2024-09-23 10:17:29 -06:00
Jim Aho 6e03a0bb67
fix(docs): Fix wording in layers section in keymaps (#2474) 2024-09-12 13:57:19 -07:00
Nicolas Munnich 1c48f64730
fix(docs): Fix broken anchor in Studio setup (#2465) 2024-09-07 09:26:24 -07:00
Nicolas Munnich f0319fde94
docs(feat): Added a page on shift registers (#2452)
Added a page on shift registers
---------

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-09-07 13:19:01 +02:00
Grazfather 58207fdb2c
fix(docs): Mention display-name property in layer docs (#2460) 2024-09-06 20:03:23 -07:00
Peter Johanson 3975d2fdaf feat: Add studio related documentation.
* Document setting up studio for a new keyboard definition.
* Document how to enable ZMK Studio for a build, adding reserved layers,
  and controlling which behaviors are built into a studio firmware.
* Document `&studio_unlock` behavior.
* Document studio configuration options.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-09-05 12:22:08 -06:00
dependabot[bot] 0f972f1cc3 chore(deps): bump web-tree-sitter from 0.20.8 to 0.23.0 in /docs
Bumps [web-tree-sitter](https://github.com/tree-sitter/tree-sitter) from 0.20.8 to 0.23.0.
- [Release notes](https://github.com/tree-sitter/tree-sitter/releases)
- [Changelog](https://github.com/tree-sitter/tree-sitter/blob/master/CHANGELOG.md)
- [Commits](https://github.com/tree-sitter/tree-sitter/compare/v0.20.8...v0.23.0)

---
updated-dependencies:
- dependency-name: web-tree-sitter
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-09-01 22:57:37 -07:00
Nicolas Munnich 266227b580
refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
Cem Aksoylar aae4feeda8 chore(deps): npm update on docs 2024-09-01 21:37:47 -07:00
Cem Aksoylar b74cd39ab5 chore(blog): Use truncate markers 2024-09-01 00:15:23 -07:00
Cem Aksoylar 0120156002 refactor(blog): Use global authors 2024-09-01 00:15:23 -07:00
Cem Aksoylar 745b960593 fix(docs): Fix broken anchors 2024-09-01 00:13:46 -07:00
dependabot[bot] 882226e261 chore(deps-dev): bump webpack from 5.89.0 to 5.94.0 in /docs
Bumps [webpack](https://github.com/webpack/webpack) from 5.89.0 to 5.94.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.89.0...v5.94.0)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-08-31 17:13:32 -07:00
dependabot[bot] d74896d780 chore(deps): bump micromatch from 4.0.5 to 4.0.8 in /docs
Bumps [micromatch](https://github.com/micromatch/micromatch) from 4.0.5 to 4.0.8.
- [Release notes](https://github.com/micromatch/micromatch/releases)
- [Changelog](https://github.com/micromatch/micromatch/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/micromatch/compare/4.0.5...4.0.8)

---
updated-dependencies:
- dependency-name: micromatch
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-08-31 17:06:43 -07:00
Anant Thazhemadam 6946ca8b07
fix(docs): minor corrections and fix typo (#2443)
* docs(faq): minor corrections

* docs: fix typo - `s/Alterative/Alternative`

* docs(faq): use Lily58 as an example instead of Corne with revision

Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>

---------

Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-27 16:23:15 +02:00
William Brockhus b866ec031f
fix(docs): Fixing wording in the split keyboards feature page (#2440) 2024-08-25 09:31:21 +02:00
Nicolas Munnich 5f056f7199
refactor(docs): Convert the keymaps section into a base folder (#2430)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-21 10:39:18 -07:00
Nicolas Munnich 503f6c8e58
feat(docs): Add and modify docs to point users to the experimental zmk-cli (#2431)
Co-authored-by: Joel Spadin <joelspadin@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-21 10:36:23 -07:00
Peter Johanson b735a051ce fix(docs): Admonition formatting fix. 2024-08-15 12:51:38 -06:00
Peter Johanson feda96eb40 feat(studio): Initial RPC infrastructure and subsystems.
* UART and BLE/GATT transports for a protobuf encoded RPC
  request/response protocol.
* Custom framing protocol is used to frame a give message.
* Requests/responses are divided into major "subsystems" which
  handle requests and create response messages.
* Notification support, including mapping local events to RPC
  notifications by a given subsystem.
* Meta responses for "no response" and "unlock needed".
* Initial basic lock state support in a new core section, and allow specifying
  if a given RPC callback requires unlocked state or not.
* Add behavior subsystem with full metadata support and examples of
  using callback to serialize a repeated field without extra stack space needed.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-15 11:45:18 -06:00
Cem Aksoylar ea64fcaf71 fix(docs): Note direct pin use in matrix transform 2024-08-15 10:38:10 -07:00
dependabot[bot] 6fe13c9565
chore(deps-dev): bump eslint-plugin-mdx from 2.3.3 to 3.1.5 in /docs (#2128)
Bumps [eslint-plugin-mdx](https://github.com/mdx-js/eslint-mdx) from 2.3.3 to 3.1.5.
- [Release notes](https://github.com/mdx-js/eslint-mdx/releases)
- [Changelog](https://github.com/mdx-js/eslint-mdx/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mdx-js/eslint-mdx/compare/eslint-plugin-mdx@2.3.3...eslint-plugin-mdx@3.1.5)

---
updated-dependencies:
- dependency-name: eslint-plugin-mdx
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-08-15 16:15:39 +02:00
dependabot[bot] 08988ec7da
chore(deps): bump braces from 3.0.2 to 3.0.3 in /docs (#2337)
Bumps [braces](https://github.com/micromatch/braces) from 3.0.2 to 3.0.3.
- [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/braces/compare/3.0.2...3.0.3)

---
updated-dependencies:
- dependency-name: braces
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-08-15 16:14:45 +02:00
Cem Aksoylar 96cd3a1ce2 refactor(docs): Remove unnecessary jsx includes 2024-08-13 23:03:15 -07:00
Cem Aksoylar 4faeb365b1 feat(docs): Add keyboard vs consumer variants note 2024-08-13 23:03:15 -07:00
Cem Aksoylar ba0dee088f feat(docs): Add section on nesting mod-morphs
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-13 14:56:07 -07:00
Cem Aksoylar 0d15ae84f4 fix(docs): Fix mod-morph terms from keycodes to bindings 2024-08-13 14:56:07 -07:00
Cem Aksoylar 8b909acdcf refactor(docs): Add subheaders for devicetree error types 2024-08-13 11:11:27 -07:00
Cem Aksoylar 3de8a56fcb feat(docs): Add a note on column numbers for DTS errors 2024-08-13 11:11:27 -07:00
Cem Aksoylar 00e4818094 fix(docs): Fix broken anchor in reset behaviors 2024-08-13 10:51:40 -07:00
Nicolas Munnich 049c070b3a
feat(docs): Minor improvements to the docs (#2411) 2024-08-13 10:47:45 -07:00
Pete Johanson 6d50ba5553 chore: Docs review tweaks.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-12 16:57:54 -07:00
Peter Johanson 3fec690def feat: Add config settings for sticky keys/hold-tap
* Add new Kconfig symbols to config max held sticky-keys/hold-taps
  and for max captured events during hold-tap resolution.
2024-08-12 16:57:54 -07: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