docs: Add note about .keymap changes when using Studio #2558
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
petejohanson
added
documentation
docs/docs/features/studio.md
Outdated
| @@ -14,6 +14,12 @@ 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. | |||
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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 (aside from adding additional empty layers when necessary) you should not make any further changes to the `.keymap` file. |
Feel free to rephrase, just thought this ought to be mentioned.
There was a problem hiding this comment.
I think adding that at the end of the sentence reads better than in the middle. Thoughts?
There was a problem hiding this comment.
It certainly matches the flow of the sentence better, I just couldn't think of a good phrasing off the top of my head for that way round.
There was a problem hiding this comment.
Thoughts on the updated version?
petejohanson
force-pushed
the
studio/note-that-dot-keymap-changes-wont-apply
branch
from
9c921a8 to
e4fd3f3
Compare
Nick-Munnich
approved these changes
Oct 16, 2024
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.
No description provided.