measlesbagel
3893d50e13
Docs: added mod morph page ( #749 )
...
* docs(behaviors): add mod-morph doc page
* docs(behaviors): add mod-morph doc page
* docs(mod-morph): add note about sent modifiers
* docs(mod-morph): fixed prettier formatting
2021-04-05 18:04:38 -05:00
Cody McGinnis
d956193251
change "Under Development" to "Beta Testing"
2021-03-10 13:45:50 -05:00
Cody McGinnis
ac50e741be
move the information to its own page
2021-03-10 13:45:50 -05:00
Joel Spadin
0955ffef65
docs: Add docs for setting up vscode
...
Added a docs page with tips for setting up VS Code's code completion to work
in ZMK's source files. Info for other IDEs can be added here later as needed.
2021-02-09 00:45:55 -05:00
KemoNine
1adb2d5f84
feat(docs): add information on how to update the documentation to the docs
2021-01-29 20:44:39 -06:00
Okke Formsma
89567d3150
docs(sticky keys): document sticky keys and sticky layers
2021-01-24 23:30:05 -05:00
Pete Johanson
e8aa576781
refactor(docs): Move combos under Features.
...
* Since combos aren't a behavior, but a new high level keymap
feature, move under Features section.
2021-01-24 16:42:44 -05:00
Okke Formsma
feb0d5b90c
feat(combos): initial implementation
...
closes #45
2021-01-13 21:07:41 -05:00
Joel Spadin
5aa8a07aa9
feat(docs): add keymap upgrader
...
Added a documentation page with a script that upgrades deprecated key
codes and behaviors to their replacements.
Fixes #299
2020-12-10 12:23:05 +00:00
innovaker
2744f44e73
refactor(docs): Integrate Dev Guides
into Development
section
...
Improves discoverability.
2020-11-20 22:31:56 -05:00
innovaker
2d50302a02
refactor(docs): Integrate USB Logging
into Development
section
...
Improves discoverability.
2020-11-20 22:31:56 -05:00
innovaker
532c1987b2
refactor(docs): Move dev-
documents into /development
...
Aligns to conventions introduced by newer documentation.
2020-11-20 22:31:56 -05:00
innovaker
bb43c7e053
docs: Rename someSidebar
to docs
2020-11-18 10:47:08 +00: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
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
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
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
innovaker
288e60ea97
docs: Format docs with prettier
...
npx prettier --write .
2020-10-25 21:25:08 +00:00
Mega Mind
cc21167d57
Added docs for external power output
2020-10-14 00:27:32 +08:00
kurtis-lew
a58a8412c7
Documented Issue #220
2020-10-09 08:15:38 -07:00
Pete Johanson
cf970efb98
feat(bluetooth): Proper bond management, identity support for non-splits
...
* Add `bt` behavior that can be used to perform certain actions,
such as next/prev identity, reset identity, etc.
NOTE: Multiple identities is only supported for non-split shields,
due to missing Zephyr identity functionality for dual
central/peripheral devices.
* Proper bond reset tied to action, that honors peripheral bonds,
so folks can reset and pair to other hosts, without breaking
bonds between splt halves.
2020-09-13 22:33:05 -04:00
Pete Johanson
e796e7c3e6
Merge pull request #165 from kurtis-lew/troubleshooting
...
Troubleshooting - Revised Copy of PR 150
2020-09-09 23:15:21 -04:00
kurtis-lew
bdeb6865e1
Update sidebars.js
2020-09-06 19:55:56 -07:00
Pete Johanson
ba07fd1879
Merge pull request #154 from chenkevinh/docs/encoders
...
Encoder documentation
2020-09-06 12:23:11 -04:00
Pete Johanson
e559cb2d71
Add hold-tap to sidebar.
2020-09-03 10:14:16 -04:00
Kevin
6f74e61dd3
Added user and dev encoder docs
2020-09-02 18:25:46 -07:00
Kevin
068626d1a7
Some work on encoder docs
2020-09-01 21:12:09 -07:00
Kevin
dad2d339b3
Added customization page
2020-08-29 17:46:00 -07:00
Kevin
35dc46bfbb
Made separate build and flash page with updated content
2020-08-29 15:51:08 -07:00
Cody McGinnis
26414a6982
fix(docs): move testing docs to website docs
2020-08-28 16:21:31 -04:00
Pete Johanson
805ea77005
feat(behaviors): Add &bootloader
behavior.
...
* Allow reset behavior to have a type property.
* Add `bootloader` node that triggers DFU UF2
bootloader mode using the AdaFruit nrf52
bootloader.
2020-08-21 11:23:45 -04:00
Cody McGinnis
feadfc93dc
feat(docs): create a bond clearing page
2020-08-19 00:07:08 -04:00
Pete Johanson
d2d9fc86cf
feat(docs): Basic mod-tap behavior docs.
2020-08-18 15:24:38 -04:00
Pete Johanson
63e02d60dc
feat(behaviors): Add &none behavior
2020-08-18 14:28:11 -04:00
Nick
c92f114efe
Add lighting behavior docs
2020-08-08 17:23:11 -05:00
Pete Johanson
dd8deceed0
Add basic layer behavior docs.
2020-08-07 16:29:52 -04:00
Pete Johanson
14eef91da1
Better user setup docs.
2020-08-07 15:05:25 -04:00
Pete Johanson
10683fe1f8
Docs re-org, start of some keymap docs.
2020-08-06 15:04:31 -04:00
Pete Johanson
e1ea833bb3
Flesh out documentation skeleton.
2020-08-05 14:04:08 -04:00
Pete Johanson
fedd4381c2
Initial user setup docs, setup script fixes.
2020-08-04 14:12:10 -04:00
Pete Johanson
092fa866af
Add doc on enabling USB logging.
2020-07-07 11:58:12 -04:00
Pete Johanson
48f3f86a83
Initial shield dev guide.
2020-07-06 23:30:07 -04:00
Pete Johanson
bd1e2b069b
Expanded dev docs on boards/shields/keymaps.
2020-07-06 11:40:03 -04:00
innovaker
c14beb7ee7
docs: Switch positions of 'hardware' and 'faq' on sidebars [ #22 CR, #11 ]
2020-06-13 19:54:55 +01:00
innovaker
30985517b8
docs: add faq to sidebars [ #11 ]
2020-06-13 18:47:20 +01:00
innovaker
d11ade45d3
[ #16 ] Replaced 'Basics' with 'Getting Started'
2020-06-12 16:08:20 +01:00
Pete Johanson
749df61a2e
Add docs about clean room design.
2020-05-31 10:54:14 -04:00
Pete Johanson
e00408d746
Initial work on basic documentation.
2020-05-25 21:33:21 -04:00