Commit Graph

260 Commits

Author SHA1 Message Date
innovaker 6cf13f6b80 docs(key-press): Change `codes` to `usages`
`usages` is a more accurate term in this context.
2020-11-16 17:32:51 -05:00
innovaker 2871dca9bf refactor(docs): Change `behavior` to `behaviors`
Makes a better URL.
2020-11-16 15:33:44 -05:00
innovaker a685d88744 refactor(docs): Change `feature` to `features`
Makes a better URL.
2020-11-16 15:33:44 -05:00
innovaker aa8d0c1c79 refactor(docs): Remove explicit document ids (part 2)
This was missed in: 4d42e792c5
2020-11-12 07:42:48 -05:00
innovaker 4d42e792c5 refactor(docs): Remove explicit document ids
Aligns older documents with newer file-based ids.
2020-11-11 23:40:49 -05:00
Okke Formsma d5cc504b3a docs: update modifier docs 2020-11-11 14:04:35 -05:00
Nick ae51000d60 fix(underglow): Switch from legacy SPI to SPIM 2020-11-10 23:06:29 -05:00
Pete Johanson 0031f9bd4d
Merge pull request #357 from petejohanson/ble/remove-unpair-combo
fix(ble): Remove unpair combo code.
2020-11-10 15:04:28 -05:00
Pete Johanson 7d16186b7a fix(ble): Remove unpair combo code.
* Favor the settings reset images for this.
2020-11-10 14:53:03 -05:00
Nick 0be904c34f fix(underglow): Add CONFIG_ to underglow Kconfigs 2020-11-08 10:33:56 -06:00
Okke Formsma 0d02441abe docs(codes): add modifier functions
Refactor and expand codes documentation to include modifier functions.

Closes #330.
2020-11-07 12:00:19 -05:00
innovaker 5d04110a58 docs(key-press): Update for standardized keys
Replace existing HID Usage Tables link with links to the new codes documentation.
2020-11-06 15:02:12 -05:00
innovaker 642ec46c1f docs(intro): Update for standardized keys
Update links to the new codes documentation.
2020-11-06 15:02:12 -05:00
innovaker ff638eb010 docs(codes): Add (key) codes documentation
Create codes documentation for standardized keys.

Closes #218.  Fixes #308.  Ref #21.
2020-11-06 15:02:12 -05:00
Pete Johanson eff1b8223b refactor(keys): Unify usage page.
* Remove need for separate `&cp` behavior, but
  keep it for now for backward compat.
* Refactor sensor inc/dec as well.
2020-11-05 14:55:40 -05:00
innovaker 5f83568a93 docs(key press): Replace deprecated `NUM_1` with `N1`
This should've been changed in: b8f6d52ae5
2020-11-05 11:47:34 -05:00
innovaker 651204c121 docs: Reformat example keymaps
Align to wider columns to improve readability for newcomers.
2020-11-03 23:50:54 -05:00
innovaker b8f6d52ae5 docs: Replace deprecated key names
Follow-up to #21.
2020-11-03 23:50:54 -05:00
Joel Spadin c3e7742f9c fix(docs): remove incorrect defines for outputs
The output selection behaviors page still referenced defines that were
removed while reviewing the PR. Updated the docs to match the code.
2020-11-03 19:38:56 -05:00
innovaker a1dd216519 docs: formatted with prettier 2020-11-03 08:19:00 -05:00
Okke Formsma 4f258efbf1 initial implementation for modifiers
https://github.com/zmkfirmware/zmk/issues/86
2020-11-03 00:19:37 -05:00
Chiyuan Zhang a9e729b427 make note about keyboard name more explicit 2020-11-02 23:30:03 -05:00
Chiyuan Zhang 9b941b7509 tweak doc according to PR feedback 2020-11-02 23:30:03 -05:00
Chiyuan Zhang e7cb863a41 update doc for new shield in user repo 2020-11-02 23:30:03 -05:00
Evan a32d14cc19 Add Github.com personal token to prerequisites. 2020-11-02 16:50:27 -05:00
innovaker 4672a0cbb5
docs(outputs): run prettier on outputs.md (#317)
Fixes #269
2020-10-31 12:00:02 -04:00
Pete Johanson 1766b090ee feat(docs): Warn of battery life impact of logging 2020-10-31 00:30:19 -04:00
Pete Johanson 7e0924107c feat(docs): Link to outputs behavior docs. 2020-10-31 00:23:16 -04:00
Joel Spadin 2fe1fbb526 feat(endpoints): rename behavior to outputs
"Outputs" is probably easier for most people to understand than "endpoints".
2020-10-28 18:15:05 -05:00
Joel Spadin 600bba25f0 feat(endpoints): add preferred endpoint setting
Added a new setting to remember the user's preferred endpoint. When both USB and
BLE are connected, the preferred endpoint will be used.

Added a new behavior to control this setting. It supports commands:

    &end END_USB - Prefer USB output
    &end END_BLE - Prefer BLE output
    &end END_TOG - Toggle between USB and BLE
2020-10-28 18:15:05 -05:00
Pete Johanson cb922fd8a2 feat(docs): Add Boardsource 3x4 to hardware list. 2020-10-27 23:32:44 -04:00
Pete Johanson 2f09957ae2
Merge pull request #301 from innovaker/docs-eslint-prettier
docs: Add eslint, prettier and eslint-mdx support
2020-10-27 12:56:44 -04:00
Pete Johanson c707ab45ef
Merge pull request #297 from Nicell/boards/reviung41
Add Reviung41 Shield Definitions
2020-10-27 00:27:17 -04:00
Pete Johanson b1bfff5b5a
Merge pull request #264 from careyk007/setup_sh__curl_always_required
Add support for wget to setup.sh
2020-10-25 23:39:47 -04:00
innovaker 288e60ea97 docs: Format docs with prettier
npx prettier --write .
2020-10-25 21:25:08 +00:00
Nick 7296b96797 Add Reviung41 Shield Definitions 2020-10-24 21:08:00 -05:00
Pete Johanson 518bcacba1
Merge pull request #280 from Tsquash/txpowerdocs
DocumentedTX Power Config in Troubleshooting
2020-10-23 12:36:28 -04:00
Caleb Lightfoot 1a6d373d16 Added Sentence For Link to Zephyr Docs 2020-10-21 19:57:46 -05:00
Caleb Lightfoot d07a46a334 Changed Wording of Text 2020-10-21 19:44:49 -05:00
innovaker cd683b8dd6 chore(docs): Replace homePageId with slug: /
Fix warning ...
The docs plugin option homePageId=intro is deprecated. To make a doc the "home", prefer frontmatter: "slug: /"

Follow-up to #286.
2020-10-21 13:52:25 +01:00
innovaker a796ee574f fix(docs): Remove empty links
Prerequisite fixes for Docusaurus 2.0.0-alpha.65 (#286) which has stricter markdown rules.
2020-10-21 13:51:37 +01:00
Pete Johanson ef37f17796
Merge pull request #109 from Nicell/underglow/state-persistence
Add RGB underglow state Kconfig and settings
2020-10-18 22:29:55 -04:00
Kellen Carey 4bd41b9bf9 add wget flag to example 2020-10-15 16:53:16 -07:00
Pete Johanson a1387eb041
Merge pull request #250 from Tsquash/docs
Added Feature Matrix for Intro.md
2020-10-15 11:24:15 -04:00
Pete Johanson 548fa2a6eb
Merge pull request #277 from megamind4089/docs/ext-power
Added docs for external power output
2020-10-15 11:18:42 -04:00
Caleb Lightfoot 91b208faf3 Documented TX Power Config in Troubleshooting 2020-10-13 21:12:29 -05:00
Pete Johanson b2cad7e597 fix(docs): Proper block for romac shield. 2020-10-13 19:50:24 -04:00
Mega Mind cc21167d57 Added docs for external power output 2020-10-14 00:27:32 +08:00
Pete Johanson b193e5b1bc
Merge pull request #265 from kurtis-lew/actuallyissue138
Addressing #138 - ZMK Config Folders
2020-10-13 00:29:37 -04:00
Pete Johanson 47cfcb42d2
Merge pull request #257 from kurtis-lew/issue138
Adressing Issue #181 - Split Keyboard Documentation
2020-10-13 00:04:12 -04:00