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

Document ZMK-specific KConfig and DT settings #628

Closed
joelspadin opened this issue Jan 24, 2021 · 1 comment
Closed

Document ZMK-specific KConfig and DT settings #628

joelspadin opened this issue Jan 24, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@joelspadin
Copy link
Collaborator

We've had a few people ask recently how to adjust the debounce period, and there are settings for it (e.g. https://github.com/zmkfirmware/zmk/blob/main/app/drivers/zephyr/dts/bindings/kscan/zmk%2Ckscan-gpio-matrix.yaml#L17 for matrix kscan) but they aren't described anywhere in the documentation.

It would be very helpful to have a place in the documentation for the ZMK-specific KConfig options and DT properties, but like we have for behaviors. Ideally we would generate this from the KConfig and bindings YAML files directly, but if that is too difficult, manually documenting some of the more commonly used things would be a good start.

We should also link to Zephyr's documentation for any options that are particularly useful for ZMK, like USB polling rate.

@joelspadin joelspadin added the documentation Improvements or additions to documentation label Jan 24, 2021
@joelspadin
Copy link
Collaborator Author

I've started working on manually documenting the existing settings and adding some documentation on how to set them.

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

2 participants