Commit graph

648 commits

Author SHA1 Message Date
Kurtis Lew
0721c30a98 Update Mod-Tap, Layer-Tap, and Hold-Tap to better reference each other 2022-07-20 20:24:11 -07:00
Kurtis Lew
7b5296560d Fix: Ensure CAPSLOCK resolves on tap, LSHIFT resolves on hold 2022-07-20 20:24:11 -07:00
Kurtis Lew
0c0618d51b Improve sticky hold section 2022-07-20 20:24:11 -07:00
Kurtis Lew
bd2ffe81fd Improve clarity of hold-tap documentation
- Convert positional-hold-tap section to paragraph-form
- Various edits for flow and grammar
- Increase font size of output descriptors in `comparison.svg` from 30pt to 36pt
- Add **Common Use-Cases** section with tabs for homerow mods, autoshift, sticky-holds, and toggle/momentary holds
2022-07-20 20:24:11 -07:00
Kurtis Lew
0f50ff2a4f Update timing of hold-tap comparison 2022-07-20 20:24:11 -07:00
Kurtis Lew
def068251d Update bindings section in tap-dance.md 2022-07-20 20:24:11 -07:00
Kurtis Lew
ee89f6a559 Update images 2022-07-20 20:24:11 -07:00
Kurtis Lew
e5425ca62d Adjust body text rag in comparison.svg 2022-07-20 20:24:11 -07:00
Kurtis Lew
d92db89a4f Increase body text size in comparison.svg 2022-07-20 20:24:11 -07:00
Kurtis Lew
3e150ed789 Increase size of hold-tap comparison 2022-07-20 20:24:11 -07:00
Kurtis Lew
c3d7dc4866 fix(docs): Update tap-dance and hold-tap documentation
- Replace raster timing diagrams with vector assets
- Improve conciseness of tap-dance docs by adding tabs for example implementation
- Expand upon tap-dance bindings and the effect of binding index on the number of keypresses required to output the bindng

Co-Authored-By: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-07-20 20:24:10 -07:00
GreenAirplane
f68692effd
feat(docs): Document behavior queue limit for Macros (#1384)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
2022-07-20 16:17:19 +01:00
byran.tech
b1ce8a0d33
fix(docs): typo fixes 2022-07-12 08:47:19 +01:00
Cem Aksoylar
41c9d81096 fix(docs): Update config docs for split Kconfig refactor 2022-07-05 08:42:27 +01:00
Cem Aksoylar
19d8c5ba40 feat(docs): Document new underglow Kconfig 2022-07-05 08:42:27 +01:00
Cem Aksoylar
851c37e14f fix(docs): Apply suggestions from #722 reviews 2022-07-05 08:42:27 +01:00
Joel Spadin
ae78aa247a feat(docs): Update power and lighting config pages
Moved battery configuration to its own page to match the feature page.

Documented that external power is disabled when in sleep mode.

Clarified that the *_START configs apply on first boot, and any changes
after that are persisted.
2022-07-03 18:55:54 +01:00
Joel Spadin
1646cd7f30 feat(docs): Add a simpler matrix transform example 2022-07-03 18:55:54 +01:00
Joel Spadin
6e67e4a3a5 feat(docs): Update direct GPIO configuration 2022-07-03 18:55:54 +01:00
Joel Spadin
74b4933980 feat(docs): Clarify descriptions of config files 2022-07-03 18:55:54 +01:00
Joel Spadin
e0e0928f9c fix(docs): Update config docs for review feedback 2022-07-03 18:55:54 +01:00
Joel Spadin
01ffea1b47 feat(docs): Update configuration overview 2022-07-03 18:55:54 +01:00
Joel Spadin
c350f7130b fix(docs): Fix links in config pages 2022-07-03 18:55:54 +01:00
Joel Spadin
2b122acfc3 feat(docs): Updating lighting config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
e8e6b2a333 feat(docs): Update general system config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
e46eaf5617 feat(docs): Update power config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
71b8f9d4ac feat(docs): Update display config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
bf84481b47 feat(docs): Update behavior config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
d36792db2d feat(docs): Update kscan config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
11861a4d30 docs: Add documentation for config options 2022-07-03 18:55:54 +01:00
Cem Aksoylar
91de215bf0 fix(docs): Add missing underglow on/off defines 2022-07-03 13:30:25 +01:00
Kurtis Lew
edc60e5848 fix(docs): Update keycode usage ID for numeric 4 in key-press.md
Co-Authored-By: Robert U <978080+urob@users.noreply.github.com>
2022-06-20 23:27:57 -04:00
Peter Johanson
a7e857f7e1 fix(docs): Fix acorn dep in package lock file.
* Use npm version matching Netlify to fix up our lock file.
2022-06-06 11:05:47 -04:00
Peter Johanson
1e8224c296 feat(behaviors): Add DEL/BSPC to continue list.
* Continue caps word on delete/backspace by
  default now.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-06-04 01:38:42 -04:00
Peter Johanson
8e67524e62 chore: Bump docusaurus and fix deps issue. 2022-06-03 00:35:07 -04:00
Caleb Goates
0977be622a feat(docs): Add docs for key toggle behavior 2022-06-03 00:04:41 -04:00
Yomi Ikuru
6150ad65c4
feat(docs): Add tip for improving build times 2022-05-31 21:32:13 +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
c679b7e07d fix(docs): Standardize URLs with no trailing slash
Previously, a trailing slash would be appended to all URLs when accessed
directly, but not when accessed via menus and links.

This Docusaurus configuration option keeps the URLs consistent by never
appending a trailing slash.

https://docusaurus.io/docs/api/docusaurus-config#trailing-slash
2022-05-23 10:09:53 -04:00
dependabot[bot]
c11e2caf77 chore(deps-dev): bump eslint-plugin-react from 7.28.0 to 7.30.0 in /docs
Bumps [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) from 7.28.0 to 7.30.0.
- [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.28.0...v7.30.0)

---
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>
2022-05-23 10:07:26 -04:00
dependabot[bot]
22a7a98070 chore(deps-dev): bump string-replace-loader from 3.0.3 to 3.1.0 in /docs
Bumps [string-replace-loader](https://github.com/Va1/string-replace-loader) from 3.0.3 to 3.1.0.
- [Release notes](https://github.com/Va1/string-replace-loader/releases)
- [Commits](https://github.com/Va1/string-replace-loader/compare/v3.0.3...v3.1.0)

---
updated-dependencies:
- dependency-name: string-replace-loader
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-23 00:25:55 -04:00
Kurtis Lew
8a70d5fccc
feat(docs): Add New Behavior Guide
Co-authored-by: Henré Botha <henrebotha@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2022-05-21 17:26:10 +01:00
dependabot[bot]
90f3107c49 chore(deps-dev): bump @tsconfig/docusaurus from 1.0.2 to 1.0.5 in /docs
Bumps [@tsconfig/docusaurus](https://github.com/tsconfig/bases/tree/HEAD/bases) from 1.0.2 to 1.0.5.
- [Release notes](https://github.com/tsconfig/bases/releases)
- [Commits](https://github.com/tsconfig/bases/commits/HEAD/bases)

---
updated-dependencies:
- dependency-name: "@tsconfig/docusaurus"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-19 11:02:48 -04:00
Peter Johanson
64dadfb336 refactor(tests): Move remaining tests to posix 64.
* Update docs and fix up a few lingering tests
  to consistently use native_posix_64 target.
2022-05-19 10:55:23 -04:00
dependabot[bot]
37f4f9eb4a chore(deps-dev): bump @types/react-helmet from 6.1.0 to 6.1.5 in /docs
Bumps [@types/react-helmet](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-helmet) from 6.1.0 to 6.1.5.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-helmet)

---
updated-dependencies:
- dependency-name: "@types/react-helmet"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-19 10:53:43 -04:00
dependabot[bot]
53d70dd08a chore(deps-dev): bump eslint-config-prettier in /docs
Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 8.3.0 to 8.5.0.
- [Release notes](https://github.com/prettier/eslint-config-prettier/releases)
- [Changelog](https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/eslint-config-prettier/compare/v8.3.0...v8.5.0)

---
updated-dependencies:
- dependency-name: eslint-config-prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-18 01:26:46 -04:00
dependabot[bot]
56fb07dffe chore(deps-dev): bump webpack from 5.58.2 to 5.72.1 in /docs
Bumps [webpack](https://github.com/webpack/webpack) from 5.58.2 to 5.72.1.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.58.2...v5.72.1)

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-17 01:24:30 -04:00
Stefán Páll Sturluson
d7ba7a1bee
fix(codes): typo in C_SUBTITLES. 2022-05-17 00:29:53 -04:00
Peter Johanson
6227866e8c feat(setup): Disallow split w/ wired controller.
For now, disallow wired split combination during setup.
2022-05-03 05:10:09 -04:00
Kurtis Lew
8bbbf530a7 fix(docs): Remove code-snippet backticks from customization.md title
Discussed here: https://discord.com/channels/719497620560543766/883452966114324550/970385441134104747

Code snippets in titles are not formatted properly in page titles
2022-05-01 21:14:19 +01:00