diff options
| author | Peter Johanson <[email protected]> | 2024-10-16 10:17:07 -0600 |
|---|---|---|
| committer | Pete Johanson <[email protected]> | 2024-10-16 13:09:51 -0600 |
| commit | c8841c41198186f0f104c22b97969b4ac91abe62 (patch) | |
| tree | 20aee8bf3cbde8be7db32cf921ee3dfa6969de77 | |
| parent | 993a64d5b399b0398fb934a303b0cbfd7a6ea5b1 (diff) | |
| download | zmk-c8841c41198186f0f104c22b97969b4ac91abe62.tar.gz zmk-c8841c41198186f0f104c22b97969b4ac91abe62.zip | |
docs: Add note about .keymap changes when using Studio
| -rw-r--r-- | docs/docs/features/studio.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/docs/features/studio.md b/docs/docs/features/studio.md index 5b17ec013c..fb7c90cbc3 100644 --- a/docs/docs/features/studio.md +++ b/docs/docs/features/studio.md @@ -14,6 +14,14 @@ ZMK Studio provides runtime update functionality to ZMK powered devices, allowin To unlock your keyboard to allow ZMK Studio to make changes, you'll need to add a [`&studio_unlock`](../keymaps/behaviors/studio-unlock.md) binding to the keymap. +:::note + +Once using ZMK Studio to manage your keymap, any future changes made to the `.keymap` file for your keyboard will not be applied unless you perform a "Restore Stock Settings" action from the ZMK Studio UI. + +Generally, if you intend to use ZMK Studio, then you should not make any further changes to the `.keymap` file (with the exception of adding new empty layers to then use within ZMK Studio). + +::: + ## Accessing ZMK Studio You can use ZMK Studio with Chrome/Edge at https://zmk.studio/. |