Skip to content

Contributing

Contributions are welcome. zigduck is licensed under the MIT license; see the LICENSE file in the repository.

If you’d like zigduck to support devices on other protocols such as Matter or Z-Wave, open a pull request with a suggested persistent device configuration. Include enough detail for a clear implementation plan, and keep zigduck fully reproducible.

The wiki is an Astro Starlight site in the wiki/ folder.

  • Guide pages are Markdown files in wiki/src/content/docs/. Every page has an “Edit page” link at the bottom.
  • The option reference is generated from hooks/options.json and hooks/service.json by wiki/scripts/gen-options.mjs. To change an option’s text, edit its description or example in the Nix module, then rerun hooks/get-options.sh.

To preview locally:

Terminal window
cd wiki
npm install
npm run dev

Sponsor on GitHub or buy the author a coffee.