diff --git a/docs/docs/development/build-flash.md b/docs/docs/development/build-flash.md index 1699ac5c..1a677635 100644 --- a/docs/docs/development/build-flash.md +++ b/docs/docs/development/build-flash.md @@ -119,7 +119,7 @@ For instance, building kyria firmware from a user `myUser`'s `zmk-config` folder west build -b nice_nano -- -DSHIELD=kyria_left -DZMK_CONFIG="C:/Users/myUser/Documents/Github/zmk-config/config" ``` -:::caution +:::warning The above command must still be invoked from the `zmk/app` directory as noted above, rather than the config directory. Otherwise, you will encounter errors such as `ERROR: source directory "." does not contain a CMakeLists.txt; is this really what you want to build?`. Alternatively you can add the `-s /path/to/zmk/app` flag to your `west` command. ::: diff --git a/docs/docs/development/clean-room.md b/docs/docs/development/clean-room.md index 82db3a04..45fa324e 100644 --- a/docs/docs/development/clean-room.md +++ b/docs/docs/development/clean-room.md @@ -3,7 +3,7 @@ title: Clean Room Implementation sidebar_label: Clean Room --- -:::warning +:::danger Anyone wanting to contribute code to ZMK _MUST_ read this, and adhere to the steps outlines in order to not violate any licenses/copyright of other projects diff --git a/docs/docs/development/documentation.md b/docs/docs/development/documentation.md index ff45d80a..56c4d276 100644 --- a/docs/docs/development/documentation.md +++ b/docs/docs/development/documentation.md @@ -48,7 +48,7 @@ The check commands can be run with the following procedure in a terminal that's 3. Run `npm run lint` 4. Run `npm run build` -:::warning +:::danger If any of the above steps throw an error, they need to be addressed and all of the checks re-run prior to submitting a pull request. ::: diff --git a/docs/docs/development/new-behavior.md b/docs/docs/development/new-behavior.md index 59872963..031bbb8b 100644 --- a/docs/docs/development/new-behavior.md +++ b/docs/docs/development/new-behavior.md @@ -316,7 +316,7 @@ The configuration `struct` stores the properties declared from the behavior's `. The fifth cell of `BEHAVIOR_DT_INST_DEFINE` can be set to `NULL` instead if instance-specific configurations are not required. -:::caution +:::warning Remember that `.c` files should be formatted according to `clang-format` to ensure that checks run smoothly once the pull request is submitted. ::: @@ -382,7 +382,7 @@ For the purpose of this section, we will discuss the structure of `app/dts/behav The format of a behavior's `.dtsi` file is identical to declaring an instance of the behavior in a user's keymap. The only major difference is that the value `/omit-if-no-ref/` should be placed adjacent to the label and name of the behavior, as seen in line 11 of the `gresc` example. -:::caution +:::warning If your behavior has its [`locality`](#api-structure) property set to anything other than `BEHAVIOR_LOCALITY_CENTRAL`, then the name of the node must be at most 8 characters long, or it will fail to be invoked on the peripheral half of a split keyboard. @@ -486,7 +486,7 @@ values={[ -:::caution +:::warning Remember to change the copyright year (`XXXX`) to the current year when adding the copyright headers to your newly created files. ::: diff --git a/docs/docs/development/new-shield.md b/docs/docs/development/new-shield.md index dd63fa9b..577a5bcb 100644 --- a/docs/docs/development/new-shield.md +++ b/docs/docs/development/new-shield.md @@ -100,7 +100,7 @@ which controls the display name of the device over USB and BLE. The updated new default values should always be wrapped inside a conditional on the shield config name defined in the `Kconfig.shield` file. Here's the simplest example file. -:::warning +:::danger The keyboard name must be less than or equal to 16 characters in length, otherwise the bluetooth advertising might fail and you will not be able to find your keyboard from your device. ::: diff --git a/docs/docs/development/setup.md b/docs/docs/development/setup.md index 8ce5ffde..ed945e6e 100644 --- a/docs/docs/development/setup.md +++ b/docs/docs/development/setup.md @@ -244,7 +244,7 @@ Click `Reopen in Container` in order to reopen the VS Code with the running cont The first time you do this on your machine, it will pull the docker image down from the registry and build the container. Subsequent launches are much faster! -:::caution +:::warning All subsequent steps must be performed from the VS Code terminal _inside_ the container. ::: diff --git a/docs/docs/development/usb-logging.md b/docs/docs/development/usb-logging.md index 6a8f8564..9b2977bd 100644 --- a/docs/docs/development/usb-logging.md +++ b/docs/docs/development/usb-logging.md @@ -11,7 +11,7 @@ If you are developing ZMK on a device that does not have a built in UART for deb Zephyr can be configured to create a USB CDC ACM device and the direct all `printk`, console output, and log messages to that device instead. -:::warning Battery Life Impact +:::danger Battery Life Impact Enabling logging increases the power usage of your keyboard, and can have a non-trivial impact to your time on battery. It is recommended to only enable logging when needed, and not leaving it on by default. diff --git a/docs/docs/features/conditional-layers.md b/docs/docs/features/conditional-layers.md index 7ccfdf23..44e2a5f2 100644 --- a/docs/docs/features/conditional-layers.md +++ b/docs/docs/features/conditional-layers.md @@ -47,7 +47,7 @@ Activating a `then-layer` in one conditional layer configuration can trigger the condition in another configuration, possibly repeatedly. ::: -:::caution +:::warning When configured as a `then-layer`, a layer's activation status is entirely controlled by the conditional layers feature. Even if the layer is activated for another reason (such as a [momentary layer](../behaviors/layers.md#momentary-layer) behavior), it will be immediately deactivated if the diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md index 2532fe8b..a05d1f99 100644 --- a/docs/docs/user-setup.md +++ b/docs/docs/user-setup.md @@ -202,7 +202,7 @@ storage device. Once the flash is complete, the controller should unmount the US flashed firmware. It is recommended that you test your keyboard works over USB first to rule out hardware issues, before trying to connect to it wirelessly. -:::caution Split keyboards +:::warning Split keyboards For split keyboards, only the central half (typically the left side) will send keyboard outputs over USB or advertise to other devices over bluetooth. Peripheral half will only send keystrokes to the central once they are paired and connected. For this reason it is diff --git a/docs/src/components/codes/SpellingCaution.jsx b/docs/src/components/codes/SpellingCaution.jsx index 15ba9488..953ab6b5 100644 --- a/docs/src/components/codes/SpellingCaution.jsx +++ b/docs/src/components/codes/SpellingCaution.jsx @@ -9,7 +9,7 @@ import Admonition from "@theme/Admonition"; export default function SpellingCaution() { return ( - +

Take extra notice of the spelling of the keycodes, especially the shorthand spelling. Otherwise, it will result in an elusive parsing