Contributing

PolyKybd is fully open. Contributions are welcome across all repositories.

Where to contribute

What	Repository
Documentation	thpoll83/polykybd-docs
Hardware (PCB, case, STLs)	thpoll83/PolyKybd
QMK firmware	thpoll83/qmk_firmware — branch PolyKybd
Host software	thpoll83/PolyKybdHost
Display rendering	thpoll83/adafruit-gfx-library
Test rig / CI	thpoll83/polykybd-ctnd — the HIL test & deploy station

Contributing to the docs

The docs are plain Markdown / MDX files. To contribute:

1. Fork thpoll83/polykybd-docs
2. Create a branch for your change
3. Edit or add .md / .mdx files in src/content/docs/
4. Preview locally with npm run dev
5. Open a pull request

Common contributions that are always welcome:

• Tested compatible switch additions to the Compatible Switches page
• Corrections to assembly steps
• OS-specific installation notes or troubleshooting tips
• Translations (open an issue first to coordinate)

The documentation is licensed under CC BY 4.0. By contributing, you agree that your contribution is made under the same license.

AI Assist · update-polykybd-docs

When you change a user-facing feature in the firmware or host, the update-polykybd-docs skill finds the docs pages that a change makes wrong or incomplete and extends them, so this site never drifts behind the code. At the end of a meaty session, session-retro scans it for hard-won gotchas worth recording and workflows worth codifying as new skills.

Contributing to the firmware

See Firmware Development for setup instructions. For significant changes, open an issue first to discuss the approach.

Releases

Both the firmware and the host app ship as GitHub Releases — a tagged version with customer-facing release notes, and (for the firmware) CI-built .bin/.uf2 assets. Maintainers draft the notes newest-version-first, keep them concise, then publish.

AI Assist · polykybd-github-release

polykybd-github-release drives the whole release — it drafts the notes, gets your review, then publishes with the right tag, title and assets. polykybd-release-notes just writes the changelog for a version range if that’s all you need.

Reporting issues

Open an issue on the relevant repository. For hardware/build problems, include:

• Which revision of the PCB and case you are using
• Photos if relevant
• Which step of the build guide the problem occurs at

Support the project

PolyKybd is an independent project. If you find it useful, consider supporting it financially via Ko-fi.