Commit Graph

772 Commits

Author SHA1 Message Date
Cem Aksoylar 7b4b5d4ff2 fix(docs): Fix debouncing driver support note 2023-11-13 12:37:09 -08:00
Cem Aksoylar a5c3edd51b refactor(docs): Remove local build section in customization 2023-11-13 12:34:44 -08:00
Cem Aksoylar 2554b5c88f fix(docs): Update boards in build examples to common+uf2 ones 2023-11-13 12:34:44 -08:00
Cem Aksoylar b80c0be0ce feat(blog): Add keymap editor post for spotlight series
Co-authored-by: Nick Coutsos <nick@coutsos.com>
2023-11-08 23:00:26 -08:00
Cem Aksoylar 5b49bc10cd feat(blog): Show all posts on sidebar 2023-11-08 23:00:26 -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
Nick Coutsos 9e8ee86842
chore(docs): Fix links to relocated files (#1975) 2023-10-22 09:05:49 -07:00
ReFil 82e85699ed
feat(docs): Document ZMK_BATTERY_REPORTING config (#1971)
`CONFIG_ZMK_BATTERY_REPORTING` is currently undocumented, A new KConfig section for battery has been added in line with the other sections in the configuration section of the docs, `CONFIG_ZMK_BATTERY_REPORT_INTERVAL` has been moved from system to battery for consistency
2023-10-19 14:04:04 -07:00
Cem Aksoylar a9f677007b fix(blog): Correct incorrect info re: global-quick-tap 2023-10-11 12:18:02 -07:00
dependabot[bot] 0c06023ca0 chore(deps): bump postcss from 8.4.18 to 8.4.31 in /docs
Bumps [postcss](https://github.com/postcss/postcss) from 8.4.18 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss/compare/8.4.18...8.4.31)

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-10-10 16:17:44 -07:00
ReFil 6c75d6986c feat(docs): Document globe key specific quirks 2023-10-10 14:04:28 -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
Joel Spadin 4a339093ce docs: Add highlighting for devicetree and kconfig
Added syntax highlighting for devicetree and kconfig files.

The PrismJS project is not accepting contributions right now as they
work on a version 2 of the library, so the new language files are added
directly here.

Also enabled syntax highlighting for various languages that are used in
the docs but aren't enabled in Docusaurus by default.
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
Cem Aksoylar ca5c9b4ae6
feat(blog): Add SOTF #6 (#1943)
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2023-10-05 19:53:15 -07:00
Amettler Thierry 913fdb831e
feat(docs): Add configuration snippet for layer-taps 2023-10-04 13:29:06 -07:00
Andrew Rae 11996ff7f0 refactor(behaviors): Final global-quick-tap deprecation. 2023-10-03 01:12:47 -07:00
Andrew Rae 2234be0871 refactor(docs): Apply suggestions from @caksoylar
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-10-03 01:12:47 -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
ReFil c1ebadcd2a
feat(hid): Add apple globe keycode
* feat(hid): Add apple globe keycode
* Update docs/src/data/hid.js

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
Co-authored-by: Nick Coutsos <nick@coutsos.com>
2023-09-29 13:14:31 -07:00
Jeppe Klitgaard eaeea4bdfa
feat(docs): Add missing `&kp` tip for `devicetree_unfixed.h` error 2023-09-11 23:32:09 -07:00
Cem Aksoylar f442776fe2 feat(docs): Detail logging and note extra useful options 2023-09-04 23:30:52 -07:00
dependabot[bot] 8087fa3b2b chore(deps): bump @fortawesome/fontawesome-svg-core in /docs
Bumps [@fortawesome/fontawesome-svg-core](https://github.com/FortAwesome/Font-Awesome) from 6.4.0 to 6.4.2.
- [Release notes](https://github.com/FortAwesome/Font-Awesome/releases)
- [Changelog](https://github.com/FortAwesome/Font-Awesome/blob/6.x/CHANGELOG.md)
- [Commits](https://github.com/FortAwesome/Font-Awesome/compare/6.4.0...6.4.2)

---
updated-dependencies:
- dependency-name: "@fortawesome/fontawesome-svg-core"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-04 23:20:33 -07:00
Nate Eagleson 693875675f
fix(docs): Fix typo in caps-word.md (#1924) 2023-09-04 16:59:59 -07:00
dependabot[bot] 3936298260 chore(deps-dev): bump eslint-plugin-react from 7.32.2 to 7.33.2 in /docs
Bumps [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) from 7.32.2 to 7.33.2.
- [Release notes](https://github.com/jsx-eslint/eslint-plugin-react/releases)
- [Changelog](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/jsx-eslint/eslint-plugin-react/compare/v7.32.2...v7.33.2)

---
updated-dependencies:
- dependency-name: eslint-plugin-react
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-03 22:39:26 -07:00
dependabot[bot] 8984e12f0d chore(deps-dev): bump json-schema-to-typescript in /docs
Bumps [json-schema-to-typescript](https://github.com/bcherny/json-schema-to-typescript) from 12.0.0 to 13.1.1.
- [Changelog](https://github.com/bcherny/json-schema-to-typescript/blob/master/CHANGELOG.md)
- [Commits](https://github.com/bcherny/json-schema-to-typescript/commits)

---
updated-dependencies:
- dependency-name: json-schema-to-typescript
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-03 15:25:21 -07:00
dependabot[bot] 3de23938d6 chore(deps): bump word-wrap from 1.2.3 to 1.2.4 in /docs
Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](https://github.com/jonschlinkert/word-wrap/compare/1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-02 23:11:02 -07:00
Cem Aksoylar 4e18b879bd feat(docs): Document persisted settings and debouncing 2023-09-02 23:02:17 -07:00
Cem Aksoylar b20d3178b9 feat(docs): Note devicetree limits re: macro bindings 2023-09-02 22:59:17 -07:00
Cem Aksoylar 369c7c1721 fix(docs): Correct default macro wait/tap ms 2023-09-02 22:59:17 -07:00
Cem Aksoylar 3d938033b0 feat(docs): Note GPIO flags and add examples 2023-09-02 20:49:19 -07:00
Cem Aksoylar 1e11e84d0d fix(docs): Fix row/col comments in matrix examples 2023-09-02 20:49:19 -07:00
Cem Aksoylar fd47965838 fix(docs): Remove diode-direction from direct GPIO driver 2023-09-02 20:45:29 -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
Jorge Villalobos d17c473d45
feat(docs): Improve parameterized macros docs 2023-08-02 09:57:00 -07:00
dependabot[bot] b945ffe943 chore(deps): bump semver from 5.7.1 to 5.7.2 in /docs
Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v5.7.1...v5.7.2)

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-20 09:52:20 -07:00
Maciej Konieczny aka narf cec2061dad fix(docs): Fix typos in parameterized macros docs. 2023-07-19 15:42:35 -07:00
フィルターペーパー bbb27ac027
feat(docs): Note that UF2 drive unmounts after flashing (#1859)
Add a note about the UF2 drive that automatically unmounts itself
to restart, which may surprise some new users.
2023-07-06 10:39:08 -07:00
Peter Johanson 805dd4a53b feat(behaviors): Support parameterized macros.
* Add two new compatibles for macros that
  take one or two parameters when bound in
  a keymap.
* Use `&macro_param_1to1`, `&macro_param_1to2`, `&macro_param_2to1`,
  and `&macro_param_2to2` control entries in the bindings for the macro
  to have the next binding entry have it's values substituted.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-20 11:19:28 -06:00
Peter Johanson 5763558a02 feat(blog): Add post about sensor refactor.
* Document changed configuration, support for other Zephyr
  drivers, next steps.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-18 20:45:06 -06:00
dependabot[bot] 9d714c0b69 chore(deps-dev): bump webpack from 5.80.0 to 5.86.0 in /docs
Bumps [webpack](https://github.com/webpack/webpack) from 5.80.0 to 5.86.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.80.0...v5.86.0)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-06-10 23:51:23 -07:00
dependabot[bot] 0be0d07630 chore(deps): bump minimatch and serve-handler in /docs
Bumps [minimatch](https://github.com/isaacs/minimatch) and [serve-handler](https://github.com/zeit/serve-handler). These dependencies needed to be updated together.

Updates `minimatch` from 3.0.4 to 3.1.2
- [Release notes](https://github.com/isaacs/minimatch/releases)
- [Commits](https://github.com/isaacs/minimatch/compare/v3.0.4...v3.1.2)

Updates `serve-handler` from 6.1.3 to 6.1.5
- [Release notes](https://github.com/zeit/serve-handler/releases)
- [Commits](https://github.com/zeit/serve-handler/compare/6.1.3...6.1.5)

---
updated-dependencies:
- dependency-name: minimatch
  dependency-type: indirect
- dependency-name: serve-handler
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-06-10 23:37:26 -07:00
pixls 9d39a87f67
fix(docs): Change user-setup.md order to agree with order in setup script
Fixes #1281 

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-10 17:49:30 -07:00
kadoyau 98524a9567
fix(docs): Fix INT6 keycode description 2023-06-10 12:32:50 -07:00
Albert Y a5c57fa224
feat(docs): Add an example for combining just modifiers (#1826)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-05 22:22:39 -07:00
Peter Johanson 19d883cdfe fix(bluetooth): Passkey pairing improvements.
* Capture the last 6 entered digits, and then require pressing
   Enter/Return to submit the entered digits. This matches the
   messaging shown on hosts regarding how to complete pairing.
* Fix the wording on the Kconfig menu item to accurately describe
  the feature.
2023-06-05 00:01:44 -06:00
Cem Aksoylar ace11e327f fix(docs): Fix broken link in BT troubleshooting 2023-06-02 22:07:29 -06:00