18b5980f29
- Fix port numbers across all docs (API :3001, Web :3000) - Add 6 missing modules to README, CLAUDE.md, and architecture doc (agents, health, inquiries, leads, reviews, metrics/web-vitals) - Add Swagger UI reference and /api/v1 prefix notes - Create docs/api-endpoints.md with complete REST API reference - Create docs/README.md as documentation index - Update deployment guide with Loki, Promtail, pg-backup services - Update health check table with all current endpoints Co-Authored-By: Paperclip <noreply@paperclip.ing>
880 B
880 B
GoodGo Platform Documentation
Getting Started
| Document | Description |
|---|---|
| Development Environment | Docker setup, local services, troubleshooting |
| Architecture | System design, data flow, module structure |
API Reference
| Document | Description |
|---|---|
| API Endpoints | Complete REST API endpoint reference |
| API Error Codes | Error response format and all error codes |
Operations
| Document | Description |
|---|---|
| Deployment | Production deployment guide and checklists |
| Backup & Restore | Backup procedures and disaster recovery runbook |
Audits
See audits/README.md for code quality, accessibility, and test coverage audit reports.