Last Updated: March 23, 2026
This is the single index for project documentation. Use it for correct paths; avoid creating duplicate guides at root.
| Document | Description |
|---|---|
| README | Project overview, quick start, architecture |
| TAPPS Tool Priority | TappsMCP (via direct stdio tapps-mcp) tool order and rationale for HomeIQ. See .cursor/MCP_SETUP_INSTRUCTIONS.md. |
| Tech Stack | Complete technology reference with versions |
| Rebuild Status | Phase completion tracker |
| Changelog | Version history and release notes |
| Open Epics | All open work items with priorities |
| Document | Description |
|---|---|
| API Reference | All endpoints, ports, and request/response schemas |
| API Overview | Quick links and API patterns |
| Conversation API v2 | Conversational AI endpoint specification |
| Document | Description |
|---|---|
| Service Groups | 9-domain group structure, dependency graph, deployment topology |
| Service Tiers | Criticality classification and Docker host ports |
| Event Flow | Event processing pipeline and data flow |
| Database Schema | InfluxDB + PostgreSQL schema reference |
| InfluxDB Schema | InfluxDB measurements, tags, and fields |
| Domain Structure | Domain group folder layout |
| Quick Reference | Architecture patterns overview |
| Auto-Fix Pipeline and MCP | Auto-fix pipeline, tapps-mcp (TappsMCP + docs-mcp), config-driven design |
Isolated project: The directory auto-fix-pipeline/ at repo root is the isolated project for the auto-fix pipeline and MCP design (future repo breakout). See auto-fix-pipeline/README.md and the architecture doc above.
| Document | Description |
|---|---|
| Deployment Quick Reference | Single configuration — start here |
| Deployment Runbook | Step-by-step deployment guide |
| Deployment Pipeline | CI/CD pipeline documentation |
| Docker Shared Resources | Shared volume ownership, external references |
| Nginx Proxy | Nginx reverse proxy patterns |
| Scripts Reference | Domain management, stack startup, and operational scripts |
| Document | Description |
|---|---|
| PostgreSQL Runbook | Database operations, maintenance, troubleshooting |
| Disaster Recovery | Backup, restore, and recovery procedures |
| Monitoring Setup | Prometheus + Grafana configuration |
| Service Health Checks | Health endpoint patterns and verification |
| Agent Evaluation | AI agent evaluation framework operations |
| Document | Description |
|---|---|
| Phase 5 Deployment Plan | Production deployment strategy |
| Phase 3 Readiness | ML library upgrade readiness assessment |
| Library Upgrade Plan | Dependency upgrade strategy and progress |
| Frontend Redesign | Frontend architecture and design system |
| Quality Audit | Codebase quality assessment |
| TAPPS Quality Baseline | Per-service TAPPS scores, gates, and security baseline |
| Deployment Checklist | Pre-deployment verification checklist |
| Auto-Bugfix Streaming Dashboard PRD | Stream-json parser, pipeline integration, dashboard UI (Epics 1–5) |
| Auto-Bugfix Dashboard Real-Time Updates | Epic 47: near real-time Model/Turns/Cost/Bugs/telemetry (7 stories) |
| Auto-Bugfix Subagents | Epic 48: bug-scanner subagent, -UseSubagents, scan-phase delegation |
| Document | Description |
|---|---|
| Automation Linter | YAML linting and validation service |
| Linter Rules | Complete linter rules catalog |
| Frontend Terminology | UI naming conventions and design system |
| Package | README | Purpose |
|---|---|---|
| homeiq-patterns | libs/homeiq-patterns/README.md | RAG, validation routers, post-action verifiers |
| homeiq-resilience | libs/homeiq-resilience/ | Circuit breakers, cross-group clients |
| homeiq-observability | libs/homeiq-observability/ | Structured logging, tracing, metrics |
| homeiq-data | libs/homeiq-data/ | InfluxDB client, database pool, caching |
| homeiq-ha | libs/homeiq-ha/ | HA connection manager, lint engine |
| Invalid Path | Use Instead |
|---|---|
docs/DEPLOYMENT_GUIDE.md |
docs/deployment/DEPLOYMENT_RUNBOOK.md |
docs/DEVELOPMENT.md |
docs/architecture/ |
docs/QUICK_START.md |
docs/deployment/DEPLOYMENT_RUNBOOK.md |
docs/USER_MANUAL.md |
README.md |
docs/TROUBLESHOOTING_GUIDE.md |
tools/cli/docs/TROUBLESHOOTING.md |
docs/prd/ |
docs/planning/ or root stories/ |
docs/DOCUMENTATION_INDEX.md |
This file: docs/README.md |
CONTRIBUTING.md |
Contributing in README |