Skip to content
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

Refactor sticky key and sticky layer doc pages to mention the underlying sticky key behavior #2273

Open
caksoylar opened this issue Apr 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@caksoylar
Copy link
Contributor

Both sticky keys (i.e. &sk) and sticky layers &sl are instances of the underlying sticky key behavior https://zmk.dev/docs/config/behaviors#sticky-key with different bindings values. However this isn't documented well under the behavior pages.

Ideally, "sticky key" page could describe both the specific &sk behavior and the generic zmk,behavior-sticky-key behavior underlying it. Mod-morph page is an example that does this with &gresc and zmk,behavior-mod-morph. "Sticky layer" page should also have a remark saying it is a sticky key under the hood with bindings = <&mo>;, similar to info box present in https://zmk.dev/docs/behaviors/mod-tap.

@caksoylar caksoylar added the documentation Improvements or additions to documentation label Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant