Ready to contribute
On this page
These are scoped software/documentation improvements, ready without hardware, an account, or sibling repositories. Use the GitHub issue links and stable IDs below in your branch and commits. Check CONTRIBUTING first.
| ID | Starting file and current behavior | Requested result | Acceptance and focused check |
|---|---|---|---|
| DOC-GLOSSARY-001 | docs/architecture/overview.md uses gateway, SDK, MCP, state and event without a linked newcomer glossary |
Add docs/getting-started/glossary.md, six short definitions plus a light command example; link from architecture and the docs index |
Explain reported state versus physical observation, avoid claiming a browser Grok connection; python3 scripts/check.py, website environment and python website/build.py |
| DOC-TROUBLE-001 | docs/getting-started/simulator-kit.md explains setup but has no compact symptom-to-fix lookup |
Add a troubleshooting table for missing Python, wrong folder, overwritten protected default, invalid config and disconnected simulator | Reproduce each error using an extracted kit or the existing regression evidence; give exact safe fixes and preserve checksum validation; python3 scripts/check.py, python scripts/test_simulator_kit.py |
| WEB-COPY-001 | website/documents.py renders setup snippets as selectable text without a copy button |
Add keyboard/touch copy controls to command snippets with a readable success/failure announcement | Copy exact text, preserve no-JavaScript selection, no copying secrets from outside the snippet, 44px touch target and focused success/failure test; node --test website/test_simulator.cjs, python -m unittest discover -s website, python website/build.py |
The glossary and troubleshooting tasks are documentation improvements, not claimed runtime defects. The copy control is an enhancement. Each PR should include the changed page, exact check results, and any unresolved platform limitation. Windows/Intel Mac, physical C124, real systemd and real Home Assistant verification are separate opportunities with additional prerequisites.