-
-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Physical layout docs improvements #2533
docs: Physical layout docs improvements #2533
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the work on this! In general, I think this is a major imporvement, just a few thoughts on the layout bits vis-a-vis studio's alpha-almost-beta status.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like I mentioned offline, I'll also look into replacing the PNG with an SVG -- that should hopefully work well with both light/dark themes.
Another note, it might be nice to have a pointer to the physical layouts page in the ZMK Studio feature page, similar to https://zmk.dev/docs/features/encoders#adding-encoder-support |
Co-authored-by: Cem Aksoylar <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing I didn't note in a comment but I also changed is the addition of labels to position map child nodes, following this comment and conversation on Discord.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Look good, generally. One minor comment/question.
Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Joel Spadin <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly small comments, I think the new explanations certainly help.
Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Cem Aksoylar <[email protected]>
… into studio-doc-improvements
Added a note on putting physical layouts into |
Co-authored-by: Cem Aksoylar <[email protected]>
@Nick-Munnich Can you please mark as resolved any of the items you've addressed, so we can see what (if anything) is still outstanding here from the review comments?) |
All the comments have been addressed, just wanted to let it stew for a bit in case of any further comments. Should be good to merge tonight if no other comments appear. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. @caksoylar any concerns?
I am good, I wanted to give @joelspadin a day or so in case he has comments. |
… into studio-doc-improvements
Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Peter Johanson <[email protected]>
… into studio-doc-improvements
* docs: Added layout configuration reference page * docs: Refactored and revamped physical layout creation information * docs: Added note in studio features page * docs: added studio_unlock note in features section --------- Co-authored-by: Cem Aksoylar <[email protected]> Co-authored-by: Joel Spadin <[email protected]> Co-authored-by: Peter Johanson <[email protected]>
* docs: Added layout configuration reference page * docs: Refactored and revamped physical layout creation information * docs: Added note in studio features page * docs: added studio_unlock note in features section --------- Co-authored-by: Cem Aksoylar <[email protected]> Co-authored-by: Joel Spadin <[email protected]> Co-authored-by: Peter Johanson <[email protected]>
* docs: Added layout configuration reference page * docs: Refactored and revamped physical layout creation information * docs: Added note in studio features page * docs: added studio_unlock note in features section --------- Co-authored-by: Cem Aksoylar <[email protected]> Co-authored-by: Joel Spadin <[email protected]> Co-authored-by: Peter Johanson <[email protected]>
Tried to do a revamp for improved clarity and to match the refactoring plan from #2515.
&studio_unlock
should be added to the reference keymap if the device is intended for use with zmk studioThere is some duplicated information between physical layout section and the config section. I think it's fine to have it duplicated, but would also be fine with removing one of the copies.
Subsumes #2527