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

Documentation update #85

Merged
merged 2 commits into from
Feb 15, 2025
Merged

Conversation

marleydepew
Copy link

Board/Shield Check-list

  • This board/shield is tested working on real hardware
  • Definitions follow the general style of other shields/boards upstream (Reference)
  • .zmk.yml metadata file added
  • Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
  • General consistent formatting of DeviceTree files
  • Keymaps do not use deprecated key defines (Check using the upgrader tool)
  • &pro_micro used in favor of &pro_micro_d/a if applicable
  • If split, no name added for the right/peripheral half
  • Kconfig.defconfig file correctly wraps all configuration in conditional on the shield symbol
  • .conf file has optional extra features commented out
  • Keyboard/PCB is part of a shipped group buy or is generally available in stock to purchase (OSH/personal projects without general availability should create a zmk-config repo instead)

logically this should say to add `timerless` if you don't want the timeout
I fixed the link to the advanced config documentation
@marleydepew
Copy link
Author

Hello @nickconway This is my first time contributing to an open source project. I wanted to add a few fixes to the Leader key documentation. I didn't mess with anything more technical than that. I'm not sure if I'm required to do further testing or complete the checklist before opening the pull request?

@nickconway
Copy link
Owner

@marleydepew thanks for the contribution, and welcome to open source!

Since it's just docs I'll merge it in even though it isn't passing the tests, I've been needing to get this and all my other PRs up to date with the current version of ZMK anyway so thanks for the reminder, and if you've been using the leader key at all I hope it's made your keyboard usage better :)

@nickconway nickconway merged commit b3db09e into nickconway:leader-key Feb 15, 2025
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants