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

Docs: New-shield guide Metadata section should list some well-known interconnects #2562

Open
amacleod opened this issue Oct 17, 2024 · 3 comments · May be fixed by #2563
Open

Docs: New-shield guide Metadata section should list some well-known interconnects #2562

amacleod opened this issue Oct 17, 2024 · 3 comments · May be fixed by #2563

Comments

@amacleod
Copy link
Contributor

Currently https://zmk.dev/docs/development/hardware-integration/new-shield#metadata shows a simple example of the requires: field in my_keyboard.zmk.yml, a Hardware Metadata file, showing [pro_micro] as the required interconnect. However, it does not mention any of the others by name.

As a first-time shield builder, I know from context and community that interconnects exist and roughly what they are, but not in enough detail to know their specific names as they should appear in a requires: clause in metadata. A little bit of hand-holding would go a long way in that section.

Expand the description of the metadata example to point out a few more well-known interconnects, like seeed_xiao and arduino_uno and, if reasonable, point readers at how to look up the names of others.

@amacleod
Copy link
Contributor Author

Even a link to https://github.com/zmkfirmware/zmk/tree/main/app/boards/interconnects could help intermediate quasi-newbies like me orient themselves 😃

@amacleod
Copy link
Contributor Author

Since https://github.com/zmkfirmware/zmk/tree/main/app/boards/interconnects mentions Arduino Uno, Blackpill, Pro Micro, and Seeed XIAO, maybe those would be a good list to include in the metadata section.

@amacleod
Copy link
Contributor Author

Opened #2563 as a potential fix

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 a pull request may close this issue.

1 participant