Apply suggestions from code review

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Nicolas Munnich 2024-08-18 07:14:45 +02:00 committed by GitHub
parent 3fe439b4aa
commit 0fcbafeaeb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 7 additions and 7 deletions

View file

@ -28,7 +28,7 @@ Refer to the [Configuration](/docs/config) documentation for more details on thi
## Keymap ## Keymap
Once you have the basic user config completed, you can find the keymap file in `config/<keyboard>.keymap` and customize from there. Once you have the basic user config completed, you can find the keymap file in `config/<keyboard>.keymap` and customize from there.
Refer to the [Keymap](keymaps/index.mdx) documentation to learn more. Refer to the [Keymaps](keymaps/index.mdx) documentation to learn more.
## Publishing ## Publishing

View file

@ -591,7 +591,7 @@ Add the following line to your keymap file to add default encoder behavior bindi
sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>; sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>;
``` ```
Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](../features/encoders.md) and [Keymap](../keymaps/index.mdx) feature documentation for more details. Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](../features/encoders.md) and [Keymaps](../keymaps/index.mdx) documentation pages for more details.
</TabItem> </TabItem>
</Tabs> </Tabs>

View file

@ -5,7 +5,7 @@ sidebar_label: Caps Word
## Summary ## Summary
The caps word behavior behaves similar to a caps lock, but will automatically deactivate when any key not in a continue list is pressed, or if the caps word key is pressed again. For smaller keyboards using [mod-taps](mod-tap), this can help avoid repeated alternating holds when typing words in all caps. The caps word behavior behaves similar to a caps lock, but will automatically deactivate when any key not in a continue list is pressed, or if the caps word key is pressed again. For smaller keyboards using [mod-taps](mod-tap.md), this can help avoid repeated alternating holds when typing words in all caps.
The modifiers are applied only to the alphabetic (`A` to `Z`) keycodes, to avoid automatically applying them to numeric values, etc. The modifiers are applied only to the alphabetic (`A` to `Z`) keycodes, to avoid automatically applying them to numeric values, etc.

View file

@ -50,7 +50,7 @@ with [modifier functions](../modifiers.mdx#modifier-functions) can be used inste
### Bindings ### Bindings
Like [hold-taps](hold-tap), macros are created by composing other behaviors, and any of those behaviors can Like [hold-taps](hold-tap.md), macros are created by composing other behaviors, and any of those behaviors can
be added to the `bindings` list, e.g.: be added to the `bindings` list, e.g.:
```dts ```dts
@ -218,7 +218,7 @@ Below are some examples of how the macro behavior can be used for various useful
### Layer Activation + More ### Layer Activation + More
Macros make it easy to combine a [layer behavior](layers), e.g. `&mo` with another behavior at the same time. Macros make it easy to combine a [layer behavior](layers.md), e.g. `&mo` with another behavior at the same time.
Common examples are enabling one or more modifiers when the layer is active, or changing the RBG underglow color. Common examples are enabling one or more modifiers when the layer is active, or changing the RBG underglow color.
To achieve this, a combination of a 0ms wait time and splitting the press and release between a `&macro_pause_for_release` is used: To achieve this, a combination of a 0ms wait time and splitting the press and release between a `&macro_pause_for_release` is used:

View file

@ -19,7 +19,7 @@ If you are reviewing these errors in the GitHub Actions tab, they can be found i
### Keymap Error ### Keymap Error
If you get an error stating `Keymap node not found, check a keymap is available and is has compatible = "zmk,keymap" set` this is an indication that the build process cannot find the keymap. Double check that the `<keyboard>.keymap` file is present and has been discovered by the build process. This can be checked by looking for a line in the build log stating `-- Using keymap file: /path/to/keymap/file/<keyboard>.keymap`. Inside the keymap file ensure the keymap node has `compatible = zmk,keymap` and it's not misspelled. For more information see the [Keymap](keymaps/index.mdx) and [Config](config/index.md) documentation. If you get an error stating `Keymap node not found, check a keymap is available and is has compatible = "zmk,keymap" set` this is an indication that the build process cannot find the keymap. Double check that the `<keyboard>.keymap` file is present and has been discovered by the build process. This can be checked by looking for a line in the build log stating `-- Using keymap file: /path/to/keymap/file/<keyboard>.keymap`. Inside the keymap file ensure the keymap node has `compatible = zmk,keymap` and it's not misspelled. For more information see the [Keymaps](keymaps/index.mdx) and [Config](config/index.md) documentation.
### Devicetree Errors ### Devicetree Errors

View file

@ -4,5 +4,5 @@
/docs/features/conditional-layers /docs/keymaps/conditional-layers 301 /docs/features/conditional-layers /docs/keymaps/conditional-layers 301
/docs/features/encoders /docs/keymaps/encoders 301 /docs/features/encoders /docs/keymaps/encoders 301
/docs/codes/modifiers /docs/keymaps/modifiers 301 /docs/codes/modifiers /docs/keymaps/modifiers 301
/docs/codes/* /docs/keymaps/list-of-codes 301 /docs/codes/* /docs/keymaps/list-of-keycodes 301
/docs/features/beta-testing /docs/features/modules#beta-testing 301 /docs/features/beta-testing /docs/features/modules#beta-testing 301