🎯 Descrição
Atualizar o README.md principal para refletir a maturidade atual do projeto (v1.0.0). A documentação anterior focava no início do desenvolvimento, mas agora o projeto possui uma arquitetura robusta com Docker, Pipelines de IA e Testes.
Precisamos que o README sirva tanto como cartão de visitas para o público geral quanto como manual técnico para desenvolvedores.
✅ Objetivo
Documentar a solução completa do OncoMap, explicando claramente o problema que resolvemos, a arquitetura técnica implementada e como executar o projeto em qualquer ambiente.
Isso é crucial para:
- Facilitar a instalação por novos desenvolvedores (Onboarding).
- Demonstrar a complexidade técnica do projeto (Pipeline ETL, IA, Docker).
- Servir como base para a avaliação final da disciplina.
📝 Tarefas
- Atualizar badges de status (Versão, Cobertura de Testes, Licença).
- Descrever o Problema e a Motivação (Contexto de Saúde Pública).
- Detalhar a Solução e Funcionalidades (Mapa, Relatórios).
- Documentar a Arquitetura Técnica e Tecnologias (Node, React, Supabase, Gemini).
- Criar guia de instalação passo a passo utilizando Docker Compose.
- Explicar o Pipeline de Dados (Coleta -> PDF -> TXT -> Enriquecimento).
📊 Critérios de Aceitação
- O
README.mdna raiz do projeto deve estar atualizado. - As instruções de
docker-compose updevem funcionar para rodar o projeto do zero. - A explicação do fluxo de dados (ETL) deve estar clara para quem não conhece o código.
- Todos os links (protótipos, licença) devem estar funcionando.