feat(docs): Update behaviors config page #2055
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joelspadin
requested changes
Dec 4, 2023
docs/docs/config/behaviors.md
Outdated
Comment on lines
135
to
134
| [zmk/app/dts/bindings/behaviors/zmk,behavior-macro.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro.yaml), | ||
| [zmk/app/dts/bindings/behaviors/zmk,behavior-macro-one-param.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro-one-param.yaml), | ||
| [zmk/app/dts/bindings/behaviors/zmk,behavior-macro-two-param.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro-two-param.yaml) |
There was a problem hiding this comment.
This works, but it all kinda blends in to one long string of blue text. Maybe formatting it as a list would look better?
Suggested change
| [zmk/app/dts/bindings/behaviors/zmk,behavior-macro.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro.yaml), | |
| [zmk/app/dts/bindings/behaviors/zmk,behavior-macro-one-param.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro-one-param.yaml), | |
| [zmk/app/dts/bindings/behaviors/zmk,behavior-macro-two-param.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro-two-param.yaml) | |
| - [zmk/app/dts/bindings/behaviors/zmk,behavior-macro.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro.yaml) | |
| - [zmk/app/dts/bindings/behaviors/zmk,behavior-macro-one-param.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro-one-param.yaml) | |
| - [zmk/app/dts/bindings/behaviors/zmk,behavior-macro-two-param.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-macro-two-param.yaml) |
There was a problem hiding this comment.
Makes sense, I had thought about it but hadn't made a decision, I changed it now.
docs/docs/config/behaviors.md
Outdated
Comment on lines
204
to
200
| [zmk/app/dts/bindings/behaviors/zmk,behavior-sensor-rotate.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-sensor-rotate.yaml), | ||
| [zmk/app/dts/bindings/behaviors/zmk,behavior-sensor-rotate-var.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/behaviors/zmk%2Cbehavior-sensor-rotate-var.yaml) |
docs/docs/config/behaviors.md
Outdated
| | ----------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | ||
| | `label` | string | Unique label for the node | | | ||
| | `compatible` | string | Sensor rotation type, **must be _one_ of**:<br/>• `"zmk,behavior-sensor-rotate"`<br/>• `"zmk,behavior-sensor-rotate-var"` | | | ||
| | `#sensor-binding-cells` | int | Number of params accepted (depends on `compatible` property), **must be _one_ of**:<br/>• `<0>`<br/>• `<2>` | | |
There was a problem hiding this comment.
Written like this, it's not very clear how they depend on the compatible property.
Suggested change
| | `#sensor-binding-cells` | int | Number of params accepted (depends on `compatible` property), **must be _one_ of**:<br/>• `<0>`<br/>• `<2>` | | | |
| | `#sensor-binding-cells` | int | Must be <ul><li>`<0>` if `compatible = "zmk,behavior-sensor-rotate"</li><li>`<2>` if `compatible = "zmk,behavior-sensor-rotate-var"`</li></ul> | | |
There was a problem hiding this comment.
Clearer indeed, thanks!
docs/docs/config/behaviors.md
Outdated
| | Property | Type | Description | Default | | ||
| | ----------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | ||
| | `label` | string | Unique label for the node | | | ||
| | `compatible` | string | Sensor rotation type, **must be _one_ of**:<br/>• `"zmk,behavior-sensor-rotate"`<br/>• `"zmk,behavior-sensor-rotate-var"` | | |
There was a problem hiding this comment.
You can use <ul> and <li> tags instead of <br> and bullet characters to get an actual list here.
There was a problem hiding this comment.
Also modified this, I had copied from macros without thinking about it much.
caksoylar
force-pushed
the
docs/update-behaviors-config
branch
from
170aad3 to
f2c3153
Compare
Co-authored-by: Joel Spadin <[email protected]>
caksoylar
force-pushed
the
docs/update-behaviors-config
branch
from
f2c3153 to
3e4aca1
Compare
joelspadin
approved these changes
Dec 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the behaviors config page to do the following, split into separate commits:
#binding-cellsfor sticky keys to<1>Mouse key press behavior is not documented here, but similar to key press, it has no options to tweak so IMO it doesn't seem necessary. However move/scroll behaviors will likely need to be documented in the future.