Browse Source

refactor(docs): Change `behavior` to `behaviors`

Makes a better URL.
xmkb
innovaker 4 years ago committed by Pete Johanson
parent
commit
2871dca9bf
  1. 8
      docs/blog/2020-09-21-zmk-sotf-2.md
  2. 4
      docs/blog/2020-11-09-zmk-sotf-3.md
  3. 0
      docs/docs/behaviors/bluetooth.md
  4. 0
      docs/docs/behaviors/hold-tap.md
  5. 0
      docs/docs/behaviors/key-press.md
  6. 0
      docs/docs/behaviors/layers.md
  7. 0
      docs/docs/behaviors/lighting.md
  8. 0
      docs/docs/behaviors/misc.md
  9. 0
      docs/docs/behaviors/mod-tap.md
  10. 0
      docs/docs/behaviors/outputs.md
  11. 0
      docs/docs/behaviors/power.md
  12. 0
      docs/docs/behaviors/reset.md
  13. 2
      docs/docs/features/encoders.md
  14. 4
      docs/docs/features/keymaps.md
  15. 8
      docs/docs/intro.md
  16. 20
      docs/sidebars.js

8
docs/blog/2020-09-21-zmk-sotf-2.md

@ -16,16 +16,16 @@ Hacktoberfest activity, and a current open call for community feedback on a ZMK
So much going on in ZMK! So much going on in ZMK!
- Added a new generic [Hold Tap behavior](https://zmkfirmware.dev/docs/behavior/hold-tap) - Added a new generic [Hold Tap behavior](https://zmkfirmware.dev/docs/behaviors/hold-tap)
in [#146](https://github.com/zmkfirmware/zmk/pull/146) which now powers mod-tap, layer-tap, etc. - [okke-formsma] in [#146](https://github.com/zmkfirmware/zmk/pull/146) which now powers mod-tap, layer-tap, etc. - [okke-formsma]
- [BLE profile/connection management](https://zmkfirmware.dev/docs/behavior/bluetooth) - [BLE profile/connection management](https://zmkfirmware.dev/docs/behaviors/bluetooth)
in [#133](https://github.com/zmkfirmware/zmk/pull/133) - [petejohanson] in [#133](https://github.com/zmkfirmware/zmk/pull/133) - [petejohanson]
- Integration tests were added to automate testing of behaviors in [#131](https://github.com/zmkfirmware/zmk/pull/131) by [BrainWart] & [petejohanson] - Integration tests were added to automate testing of behaviors in [#131](https://github.com/zmkfirmware/zmk/pull/131) by [BrainWart] & [petejohanson]
- [Toggle layer behavior](https://zmkfirmware.dev/docs/behavior/layers#toggle-layer), e.g. `&tog LOWER`, in - [Toggle layer behavior](https://zmkfirmware.dev/docs/behaviors/layers#toggle-layer), e.g. `&tog LOWER`, in
[#98](https://github.com/zmkfirmware/zmk/pull/98) - [BrainWart] [#98](https://github.com/zmkfirmware/zmk/pull/98) - [BrainWart]
- Key fix for dropped press/release over HID [#93](https://github.com/zmkfirmware/zmk/pull/93)/[#96](https://github.com/zmkfirmware/zmk/pull/96) - [careyk007](https://github.com/careyk007) & [petejohanson] - Key fix for dropped press/release over HID [#93](https://github.com/zmkfirmware/zmk/pull/93)/[#96](https://github.com/zmkfirmware/zmk/pull/96) - [careyk007](https://github.com/careyk007) & [petejohanson]
- Code formatting standardized using `clang-format` in [#183](https://github.com/zmkfirmware/zmk/pull/183) - [petejohanson] - Code formatting standardized using `clang-format` in [#183](https://github.com/zmkfirmware/zmk/pull/183) - [petejohanson]
- [Bootloader reset behavior](https://zmkfirmware.dev/docs/behavior/reset#bootloader-reset), e.g. `&bootloader`, in [#116](https://github.com/zmkfirmware/zmk/pull/116) - [petejohanson] - [Bootloader reset behavior](https://zmkfirmware.dev/docs/behaviors/reset#bootloader-reset), e.g. `&bootloader`, in [#116](https://github.com/zmkfirmware/zmk/pull/116) - [petejohanson]
- Various bug fixes and documentation - Various bug fixes and documentation
## New Shields ## New Shields

4
docs/blog/2020-11-09-zmk-sotf-3.md

@ -67,7 +67,7 @@ With this change, you can add
&ext_power EP_TOG &ext_power EP_TOG
``` ```
to toggle (on/off) the power to external hardware like RGB underglow or OLEDs. Check out the [external power control](/docs/behavior/power#external-power-control) docs for more info. to toggle (on/off) the power to external hardware like RGB underglow or OLEDs. Check out the [external power control](/docs/behaviors/power#external-power-control) docs for more info.
#### Deep Sleep #### Deep Sleep
@ -78,7 +78,7 @@ included some automatic power savings by switching to PORT events on the nRF52 c
#### Output Selection #### Output Selection
[joelspadin] added [output selection](/docs/behavior/outputs) to allow selecting whether to send output over USB or BLE if both are connected. This should now help avoid having "double keypresses" when your keyboard is plugged into a host. [joelspadin] added [output selection](/docs/behaviors/outputs) to allow selecting whether to send output over USB or BLE if both are connected. This should now help avoid having "double keypresses" when your keyboard is plugged into a host.
#### Bootloader Corruption Fix #### Bootloader Corruption Fix

0
docs/docs/behavior/bluetooth.md → docs/docs/behaviors/bluetooth.md

0
docs/docs/behavior/hold-tap.md → docs/docs/behaviors/hold-tap.md

0
docs/docs/behavior/key-press.md → docs/docs/behaviors/key-press.md

0
docs/docs/behavior/layers.md → docs/docs/behaviors/layers.md

0
docs/docs/behavior/lighting.md → docs/docs/behaviors/lighting.md

0
docs/docs/behavior/misc.md → docs/docs/behaviors/misc.md

0
docs/docs/behavior/mod-tap.md → docs/docs/behaviors/mod-tap.md

0
docs/docs/behavior/outputs.md → docs/docs/behaviors/outputs.md

0
docs/docs/behavior/power.md → docs/docs/behaviors/power.md

0
docs/docs/behavior/reset.md → docs/docs/behaviors/reset.md

2
docs/docs/features/encoders.md

@ -25,7 +25,7 @@ Rotation is handled separately as a type of sensor. The behavior for this is set
sensor-bindings = <BINDING CW_KEY CCW_KEY>; sensor-bindings = <BINDING CW_KEY CCW_KEY>;
``` ```
- `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](/docs/behavior/key-press) for details on available keycodes). - `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](/docs/behaviors/key-press) for details on available keycodes).
- `CW_KEY` is the keycode activated by a clockwise turn. - `CW_KEY` is the keycode activated by a clockwise turn.
- `CCW_KEY` is the keycode activated by a counter-clockwise turn. - `CCW_KEY` is the keycode activated by a counter-clockwise turn.

4
docs/docs/features/keymaps.md

@ -30,7 +30,7 @@ For example, the simplest behavior in ZMK is the "key press" behavior, which res
(a certain spot on the keyboard), and when that position is pressed, send a keycode to the host, and (a certain spot on the keyboard), and when that position is pressed, send a keycode to the host, and
when the key position is released, updates the host to notify of the keycode being released. when the key position is released, updates the host to notify of the keycode being released.
For the full set of possible behaviors, start at the [Key Press](/docs/behavior/key-press) behavior. For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior.
## Layers ## Layers
@ -148,7 +148,7 @@ Each layer should have:
1. A `bindings` property this will be a list of behaviour bindings, one for each key position for the keyboard. 1. A `bindings` property this will be a list of behaviour bindings, one for each key position for the keyboard.
1. (Optional) A `sensor-bindings` property that will be a list of behavior bindings for each sensor on the keyboard. (Currently, only encoders are supported as sensor hardware, but in the future devices like trackpoints would be supported the same way) 1. (Optional) A `sensor-bindings` property that will be a list of behavior bindings for each sensor on the keyboard. (Currently, only encoders are supported as sensor hardware, but in the future devices like trackpoints would be supported the same way)
For the full set of possible behaviors, start at the [Key Press](/docs/behavior/key-press) behavior. For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior.
### Complete Example ### Complete Example

8
docs/docs/intro.md

@ -12,14 +12,14 @@ firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time
ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK: ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK:
| **Feature** | ZMK | BlueMicro | QMK | | **Feature** | ZMK | BlueMicro | QMK |
| ---------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: | | ------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
| Low Latency BLE Support | ✅ | ✅ | | | Low Latency BLE Support | ✅ | ✅ | |
| Multi-Device BLE Support | ✅ | | | | Multi-Device BLE Support | ✅ | | |
| [USB Connectivity](behavior/outputs) | ✅ | | ✅ | | [USB Connectivity](behaviors/outputs) | ✅ | | ✅ |
| User Configuration Repositories | ✅ | | | | User Configuration Repositories | ✅ | | |
| Split Keyboard Support | ✅ | ✅ | ✅ | | Split Keyboard Support | ✅ | ✅ | ✅ |
| [Keymaps and Layers](behavior/layers) | ✅ | ✅ | ✅ | | [Keymaps and Layers](behaviors/layers) | ✅ | ✅ | ✅ |
| [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | | [Hold-Tap](behaviors/hold-tap) (which includes [Mod-Tap](behaviors/mod-tap) and [Layer-Tap](behaviors/layers/#layer-tap)) | ✅ | ✅ | ✅ |
| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ | | [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ |
| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ | | [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ |
| [Encoders](features/encoders)[^1] | ✅ | | ✅ | | [Encoders](features/encoders)[^1] | ✅ | | ✅ |

20
docs/sidebars.js

@ -15,16 +15,16 @@ module.exports = {
"features/underglow", "features/underglow",
], ],
Behaviors: [ Behaviors: [
"behavior/key-press", "behaviors/key-press",
"behavior/layers", "behaviors/layers",
"behavior/misc", "behaviors/misc",
"behavior/hold-tap", "behaviors/hold-tap",
"behavior/mod-tap", "behaviors/mod-tap",
"behavior/reset", "behaviors/reset",
"behavior/bluetooth", "behaviors/bluetooth",
"behavior/outputs", "behaviors/outputs",
"behavior/lighting", "behaviors/lighting",
"behavior/power", "behaviors/power",
], ],
Codes: [ Codes: [
"codes/index", "codes/index",

Loading…
Cancel
Save