Welcome! This index groups the most useful docs so you can find things fast.
- Quick Start: flash pre-built firmware — docs/quick-start.md
- Hardware Guide: parts, wiring, power — docs/hardware.md
- Troubleshooting: common issues and fixes — docs/troubleshooting.md
- Build Instructions: web assets + firmware — docs/build-instructions.md
- Testing Guide: PlatformIO Unity tests — docs/testing.md
- Configuration System: correct usage patterns — docs/configuration-system.md
- Data‑Driven Config (advanced) — docs/DATA_DRIVEN_CONFIG.md
- WiFi Provisioning Test Gating — docs/wifi-provisioning-test-gating.md
- MQTT Integration: setup, topics, examples — docs/mqtt-integration.md
- Home Assistant: MQTT bridge integration — docs/home-assistant/README.md
- Apple Shortcuts: send via HTTP→MQTT — docs/apple-shortcuts.md
- Pipedream Bridge: webhook→MQTT workflow — docs/pipedream-integration.md
- LED Effects — docs/led-effects.md
- Button Debugging Guide — docs/button-debugging-guide.md
- Logging System — docs/logging-system.md
- Code Structure & directories — docs/code-structure.md
- Frontend Patterns (UI) — docs/frontend-patterns.md
- See security notes in MQTT Integration
- PCB files and notes — docs/PCB
Notes
- The MQTT Integration guide contains a note that message examples may need refreshing to match the latest web UI payloads.
- If you’re contributing, start with Code Structure and Frontend Patterns.
If anything feels unclear or missing, open an issue or PR. ❤️