| # 📚 Documentação - Cidadão.AI Backend | |
| **Autor**: Anderson Henrique da Silva | |
| **Última Atualização**: 2025-10-03 (São Paulo, Brasil) | |
| Esta pasta contém toda a documentação técnica do projeto Cidadão.AI Backend. | |
| ## 📂 Estrutura da Documentação | |
| ### 🤖 [/agents](./agents/) | |
| Documentação dos agentes de IA | |
| - `README.md` - Status de implementação de todos os agentes | |
| - 11 agentes documentados (65% de cobertura) | |
| - Documentação individual de cada agente (capacidades, API, exemplos) | |
| - **Principais**: Abaporu (orquestrador), Zumbi (anomalias), Anita (padrões), Tiradentes (relatórios) | |
| ### 📡 [/api](./api/) | |
| Documentação completa das APIs | |
| - `README.md` - Referência completa da API REST | |
| - `CHAT_API_DOCUMENTATION.md` - API de chat detalhada | |
| - `WEBSOCKET_API_DOCUMENTATION.md` - APIs WebSocket | |
| - `PORTAL_TRANSPARENCIA_INTEGRATION.md` - Integração com Portal da Transparência | |
| - `BACKEND_CHAT_IMPLEMENTATION.md` - Implementação do chat | |
| - `API_ENDPOINTS_MAP.md` - Mapa de 218 endpoints | |
| - `ENDPOINTS_CONNECTION_STATUS.md` - Status real de conexão | |
| ### 🏗️ [/architecture](./architecture/) | |
| Arquitetura e decisões técnicas | |
| - `README.md` - Visão geral da arquitetura | |
| - `AGENT_LAZY_LOADING.md` - Carregamento preguiçoso de agentes | |
| - `CONNECTION_POOLING.md` - Pool de conexões | |
| - `MONITORING_OBSERVABILITY.md` - Monitoramento e observabilidade | |
| - `PERFORMANCE_OPTIMIZATION.md` - Otimizações de performance | |
| - `REDIS_CACHE_IMPLEMENTATION.md` - Implementação de cache Redis | |
| - `MARITACA_OPTIMIZATION_GUIDE.md` - Guia de otimização Maritaca | |
| ### 🚀 [/deployment](./deployment/) | |
| Guias de deployment | |
| - `README.md` - Guia principal de deployment | |
| - `DEPLOYMENT_GUIDE.md` - Guia detalhado | |
| - `HUGGINGFACE_DEPLOYMENT.md` - Deploy no HuggingFace Spaces | |
| ### 💻 [/development](./development/) | |
| Guias para desenvolvedores | |
| - `CONTRIBUTING.md` - Como contribuir | |
| - `maritaca_integration.md` - Integração com Maritaca | |
| - `CONVERSATIONAL_AI_IMPLEMENTATION.md` - IA conversacional | |
| - `CORS_CONFIGURATION.md` - Configuração CORS | |
| - `CURSOR_PAGINATION_IMPLEMENTATION.md` - Paginação com cursor | |
| - `FRONTEND_INTEGRATION_GUIDE.md` - Guia de integração frontend | |
| - `GZIP_COMPRESSION_IMPLEMENTATION.md` - Implementação de compressão GZIP | |
| - `INDEX_CHAT_IMPLEMENTATION.md` - Implementação do chat | |
| - `/examples/integrations/` - Exemplos de código | |
| ### 🎨 [/frontend](./frontend/) | |
| Integração com frontend | |
| - `FRONTEND_CHATBOT_PROMPT.md` - Prompts do chatbot | |
| - `FRONTEND_CHAT_INTEGRATION.md` - Integração do chat | |
| - `FRONTEND_INTEGRATION.md` - Guia geral de integração | |
| - `FRONTEND_INTEGRATION_PLAN.md` - Plano de integração | |
| - `FRONTEND_STABLE_INTEGRATION.md` - Integração estável | |
| - `/examples/` - Componentes React de exemplo | |
| - `/examples/integration-example/` - Exemplo completo de integração | |
| ### 📋 [/planning](./planning/) | |
| Planejamento e roadmaps | |
| - `README.md` - Visão geral do planejamento | |
| - `AGENT_STATUS_2025.md` - Status dos agentes em 2025 | |
| - `API_DATA_STRUCTURES.md` - Estruturas de dados da API | |
| - `ROADMAP_MELHORIAS_2025.md` - Roadmap de melhorias | |
| - `SPRINT_HISTORY.md` - Histórico de sprints | |
| - `next_steps.md` - Próximos passos | |
| - `UPDATE_INSTRUCTIONS.md` - Instruções de atualização | |
| - Relatórios de trabalho e organização | |
| - `/archive/` - Documentos arquivados | |
| ### 📊 [/reports](./reports/) | |
| Relatórios técnicos | |
| - `REAL_IMPLEMENTATION_STATUS.md` - **Status real completo do projeto** | |
| - `CODEBASE_ANALYSIS_REPORT.md` - Análise do código | |
| - `IMPLEMENTATION_SUMMARY_2025_09_16.md` - Resumo de implementação | |
| - `TECHNICAL_REPORT_2025_09_16.md` - Relatório técnico | |
| - `TEST_SUMMARY.md` - Resumo de testes | |
| - `VERSION_COMPARISON_REPORT_2025_09_16.md` - Comparação de versões | |
| ### 🔧 [/troubleshooting](./troubleshooting/) | |
| Solução de problemas | |
| - `EMERGENCY_SOLUTION.md` - Soluções de emergência | |
| - `FIX_HUGGINGFACE_DEPLOYMENT.md` - Correções para HuggingFace Spaces | |
| ## 🚀 Quick Links | |
| ### Para Começar | |
| 1. [README Principal](../README.md) - Visão geral do projeto | |
| 2. [Arquitetura](./architecture/README.md) - Como funciona | |
| 3. [API Reference](./api/README.md) - Endpoints disponíveis | |
| ### Para Desenvolvedores | |
| 1. [CONTRIBUTING](./development/CONTRIBUTING.md) - Como contribuir | |
| 2. [Setup Local](./development/FRONTEND_INTEGRATION_GUIDE.md) - Configuração | |
| 3. [Exemplos](./development/examples/) - Código de exemplo | |
| ### Para Deploy | |
| 1. [Guia de Deploy](./deployment/README.md) - Todas as opções | |
| 2. [HuggingFace](./deployment/HUGGINGFACE_DEPLOYMENT.md) - Deploy atual | |
| ### Status do Projeto | |
| 1. [Status Real](./reports/REAL_IMPLEMENTATION_STATUS.md) - **Análise completa da implementação** | |
| 2. [Agentes](./agents/README.md) - Status de implementação dos agentes | |
| 3. [Roadmap](./planning/ROADMAP_MELHORIAS_2025.md) - Próximas features | |
| 4. [Reports](./reports/) - Análises técnicas | |
| --- | |
| # 📚 Documentation - Cidadão.AI Backend (English) | |
| **Author**: Anderson Henrique da Silva | |
| **Last Updated**: 2025-10-03 (São Paulo, Brazil) | |
| This folder contains all technical documentation for the Cidadão.AI Backend project. | |
| ## 📂 Documentation Structure | |
| ### 🤖 [/agents](./agents/) | |
| AI agents documentation | |
| - `README.md` - Implementation status of all agents | |
| - 11 documented agents (65% coverage) | |
| - Individual documentation for each agent (capabilities, API, examples) | |
| - **Main agents**: Abaporu (orchestrator), Zumbi (anomalies), Anita (patterns), Tiradentes (reports) | |
| ### 📡 [/api](./api/) | |
| Complete API documentation | |
| - `README.md` - Complete REST API reference | |
| - `CHAT_API_DOCUMENTATION.md` - Detailed chat API | |
| - `WEBSOCKET_API_DOCUMENTATION.md` - WebSocket APIs | |
| - `PORTAL_TRANSPARENCIA_INTEGRATION.md` - Portal da Transparência integration | |
| - `BACKEND_CHAT_IMPLEMENTATION.md` - Chat implementation | |
| - `API_ENDPOINTS_MAP.md` - Map of 218 endpoints | |
| - `ENDPOINTS_CONNECTION_STATUS.md` - Real connection status | |
| ### 🏗️ [/architecture](./architecture/) | |
| Architecture and technical decisions | |
| - `README.md` - Architecture overview | |
| - `AGENT_LAZY_LOADING.md` - Agent lazy loading | |
| - `CONNECTION_POOLING.md` - Connection pooling | |
| - `MONITORING_OBSERVABILITY.md` - Monitoring and observability | |
| - `PERFORMANCE_OPTIMIZATION.md` - Performance optimizations | |
| - `REDIS_CACHE_IMPLEMENTATION.md` - Redis cache implementation | |
| - `MARITACA_OPTIMIZATION_GUIDE.md` - Maritaca optimization guide | |
| ### 🚀 [/deployment](./deployment/) | |
| Deployment guides | |
| - `README.md` - Main deployment guide | |
| - `DEPLOYMENT_GUIDE.md` - Detailed guide | |
| - `HUGGINGFACE_DEPLOYMENT.md` - HuggingFace Spaces deployment | |
| ### 💻 [/development](./development/) | |
| Developer guides | |
| - `CONTRIBUTING.md` - How to contribute | |
| - `maritaca_integration.md` - Maritaca integration | |
| - `CONVERSATIONAL_AI_IMPLEMENTATION.md` - Conversational AI | |
| - `CORS_CONFIGURATION.md` - CORS configuration | |
| - `CURSOR_PAGINATION_IMPLEMENTATION.md` - Cursor pagination | |
| - `FRONTEND_INTEGRATION_GUIDE.md` - Frontend integration guide | |
| - `GZIP_COMPRESSION_IMPLEMENTATION.md` - GZIP compression implementation | |
| - `INDEX_CHAT_IMPLEMENTATION.md` - Chat implementation | |
| - `/examples/integrations/` - Code examples | |
| ### 🎨 [/frontend](./frontend/) | |
| Frontend integration | |
| - `FRONTEND_CHATBOT_PROMPT.md` - Chatbot prompts | |
| - `FRONTEND_CHAT_INTEGRATION.md` - Chat integration | |
| - `FRONTEND_INTEGRATION.md` - General integration guide | |
| - `FRONTEND_INTEGRATION_PLAN.md` - Integration plan | |
| - `FRONTEND_STABLE_INTEGRATION.md` - Stable integration | |
| - `/examples/` - React component examples | |
| - `/examples/integration-example/` - Complete integration example | |
| ### 📋 [/planning](./planning/) | |
| Planning and roadmaps | |
| - `README.md` - Planning overview | |
| - `AGENT_STATUS_2025.md` - Agents status in 2025 | |
| - `API_DATA_STRUCTURES.md` - API data structures | |
| - `ROADMAP_MELHORIAS_2025.md` - Improvement roadmap | |
| - `SPRINT_HISTORY.md` - Sprint history | |
| - `next_steps.md` - Next steps | |
| - `UPDATE_INSTRUCTIONS.md` - Update instructions | |
| - Work and organization reports | |
| - `/archive/` - Archived documents | |
| ### 📊 [/reports](./reports/) | |
| Technical reports | |
| - `REAL_IMPLEMENTATION_STATUS.md` - **Complete real project status** | |
| - `CODEBASE_ANALYSIS_REPORT.md` - Code analysis | |
| - `IMPLEMENTATION_SUMMARY_2025_09_16.md` - Implementation summary | |
| - `TECHNICAL_REPORT_2025_09_16.md` - Technical report | |
| - `TEST_SUMMARY.md` - Test summary | |
| - `VERSION_COMPARISON_REPORT_2025_09_16.md` - Version comparison | |
| ### 🔧 [/troubleshooting](./troubleshooting/) | |
| Problem solving | |
| - `EMERGENCY_SOLUTION.md` - Emergency solutions | |
| - `FIX_HUGGINGFACE_DEPLOYMENT.md` - HuggingFace Spaces fixes | |
| ## 🚀 Quick Links | |
| ### Getting Started | |
| 1. [Main README](../README.md) - Project overview | |
| 2. [Architecture](./architecture/README.md) - How it works | |
| 3. [API Reference](./api/README.md) - Available endpoints | |
| ### For Developers | |
| 1. [CONTRIBUTING](./development/CONTRIBUTING.md) - How to contribute | |
| 2. [Local Setup](./development/FRONTEND_INTEGRATION_GUIDE.md) - Configuration | |
| 3. [Examples](./development/examples/) - Code examples | |
| ### For Deployment | |
| 1. [Deploy Guide](./deployment/README.md) - All options | |
| 2. [HuggingFace](./deployment/HUGGINGFACE_DEPLOYMENT.md) - Current deployment | |
| ### Project Status | |
| 1. [Real Status](./reports/REAL_IMPLEMENTATION_STATUS.md) - **Complete implementation analysis** | |
| 2. [Agents](./agents/README.md) - Agents implementation status | |
| 3. [Roadmap](./planning/ROADMAP_MELHORIAS_2025.md) - Next features | |
| 4. [Reports](./reports/) - Technical analyses | |
| --- | |
| **Note**: This documentation reflects the real state of the implementation as of 2025-10-03. |