Welcome to the SQL Agent Chatbot documentation!
- Development Setup - Environment configuration, prerequisites, and tools
- Main Project README - Project overview, features, and quick start
- Infrastructure Guide - AWS architecture, resources, and deployment
- Development Workflow - Git workflow, 3-environment system, testing, and CI/CD processes
- Database & Security - RDS setup, Secrets Manager, and logging
- SQL Agent Implementation - LangChain agent with Claude 3
- API Layer Implementation - FastAPI integration and REST API
- Authentication Implementation - JWT auth with AWS Cognito
- Frontend Implementation - SPA architecture, auth flow, and deployment
- Monitoring & Observability - CloudWatch dashboards and alarms ✅
- API Reference - Interactive docs at
/docsand/redoc - Authentication Guide - Cognito integration
- Monitoring Guide - Dashboards, metrics, and alerts ✅
- Operational Runbook - Troubleshooting and emergency procedures (coming soon)
- Performance Tuning - Optimization strategies (coming soon)
| If you need to... | See... |
|---|---|
| Set up your development environment | Development Setup |
| Understand the AWS architecture | Infrastructure Guide |
| Learn about our Git workflow | Development Workflow |
| Understand the 3 environments | Development Workflow |
| Configure database access | Database & Security |
| Understand the SQL agent | SQL Agent Implementation |
| Implement authentication | Authentication Implementation |
| Build the frontend | Frontend Implementation |
| Monitor the application | Monitoring & Observability |
| Learn about the API design | API Layer Implementation |
| Test the API interactively | Run make api then visit /docs |
| Test the SQL agent locally | Main README |
| Deploy to AWS | Main README |
For current project progress and roadmap, see the Main README.
Phase 7 (Monitoring & Observability) is now complete! Key accomplishments:
- Two-dashboard monitoring strategy (AI Performance + Application Health)
- CloudWatch alarms with email notifications
- Comprehensive metrics for both AI and application performance
- Full documentation of monitoring patterns and best practices
- ~95% phase completion (operational runbook pending)
See Monitoring & Observability for the complete guide to monitoring CollibrIA.
💡 Tip: Use your editor's file tree to browse documentation files directly. All docs follow a numbered naming convention for easy navigation.