docs/INDEX.md

📑 Índice Completo da Documentação

Autor: Anderson Henrique da Silva
Última Atualização: 2025-09-25 18:45:00 -03:00 (São Paulo, Brasil)

📂 Estrutura da Documentação

🤖 /agents

Documentação dos agentes de IA

• README.md - Status de implementação de todos os agentes
• zumbi-example.md - Exemplo de uso do agente Zumbi
• abaporu.md - Documentação do agente mestre
• machado.md - Agente de análise textual
• zumbi.md - Agente investigador de anomalias

📡 /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
• BACKEND_CHAT_IMPLEMENTATION.md - Implementação do chat

🏗️ /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
• MARITACA_OPTIMIZATION_GUIDE.md - Guia de otimização Maritaca

🚀 /deployment

Guias de deployment

• README.md - Guia principal de deployment
• DEPLOYMENT_GUIDE.md - Guia detalhado
• HUGGINGFACE_DEPLOYMENT.md - Deploy no HuggingFace Spaces

💻 /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
• INDEX_CHAT_IMPLEMENTATION.md - Implementação do chat
• /examples/integrations/ - Exemplos de código

🎨 /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

📋 /planning

Planejamento e roadmaps

• README.md - Visão geral do planejamento
• AGENT_STATUS_2025.md - Status dos agentes
• 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

Relatórios técnicos

• 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
• Outros relatórios de progresso

🔧 /troubleshooting

Solução de problemas

• EMERGENCY_SOLUTION.md - Soluções de emergência
• FIX_HUGGINGFACE_DEPLOYMENT.md - Correções para HF Spaces

🚀 Quick Links

Para Começar

1. README Principal - Visão geral do projeto
2. Arquitetura - Como funciona
3. API Reference - Endpoints disponíveis

Para Desenvolvedores

1. CONTRIBUTING - Como contribuir
2. Setup Local - Configuração
3. Exemplos - Código de exemplo

Para Deploy

1. Guia de Deploy - Todas as opções
2. HuggingFace - Deploy atual

Status do Projeto

1. Agentes - Status de implementação
2. Roadmap - Próximas features
3. Reports - Análises técnicas

---

Nota: Esta documentação reflete o estado real da implementação em 2025-09-25.