diff --git a/docs/docs/customization.md b/docs/docs/customization.md index 61debb25..638ddbfc 100644 --- a/docs/docs/customization.md +++ b/docs/docs/customization.md @@ -28,7 +28,7 @@ Refer to the [Configuration](/docs/config) documentation for more details on thi ## Keymap Once you have the basic user config completed, you can find the keymap file in `config/.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 diff --git a/docs/docs/development/new-shield.mdx b/docs/docs/development/new-shield.mdx index adebb7ce..1aaab896 100644 --- a/docs/docs/development/new-shield.mdx +++ b/docs/docs/development/new-shield.mdx @@ -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>; ``` -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. diff --git a/docs/docs/keymaps/behaviors/caps-word.md b/docs/docs/keymaps/behaviors/caps-word.md index 38f3492e..e2a2bd10 100644 --- a/docs/docs/keymaps/behaviors/caps-word.md +++ b/docs/docs/keymaps/behaviors/caps-word.md @@ -5,7 +5,7 @@ sidebar_label: Caps Word ## 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. diff --git a/docs/docs/keymaps/behaviors/macros.md b/docs/docs/keymaps/behaviors/macros.md index 627d5bc1..835a7386 100644 --- a/docs/docs/keymaps/behaviors/macros.md +++ b/docs/docs/keymaps/behaviors/macros.md @@ -50,7 +50,7 @@ with [modifier functions](../modifiers.mdx#modifier-functions) can be used inste ### 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.: ```dts @@ -218,7 +218,7 @@ Below are some examples of how the macro behavior can be used for various useful ### 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. To achieve this, a combination of a 0ms wait time and splitting the press and release between a `¯o_pause_for_release` is used: diff --git a/docs/docs/troubleshooting/building-issues.md b/docs/docs/troubleshooting/building-issues.md index 1e1a9f62..24d389ab 100644 --- a/docs/docs/troubleshooting/building-issues.md +++ b/docs/docs/troubleshooting/building-issues.md @@ -19,7 +19,7 @@ If you are reviewing these errors in the GitHub Actions tab, they can be found i ### 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 `.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/.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 `.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/.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 diff --git a/docs/static/_redirects b/docs/static/_redirects index ea629e87..2113e0d9 100644 --- a/docs/static/_redirects +++ b/docs/static/_redirects @@ -4,5 +4,5 @@ /docs/features/conditional-layers /docs/keymaps/conditional-layers 301 /docs/features/encoders /docs/keymaps/encoders 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 \ No newline at end of file