18 lines
853 B
Markdown
18 lines
853 B
Markdown
# Docs
|
|
|
|
Esta pasta concentra a documentacao viva do projeto.
|
|
|
|
Arquivos:
|
|
- `../README.md`: setup local, bootstrap do virtualenv, faixa de Python suportada, comandos de teste e estrutura de imagens/manifests Kubernetes
|
|
- `refactor-plan.md`: alvo arquitetural e fases do refactor incremental
|
|
- `refactor-log.md`: historico operacional das mudancas feitas no repositorio
|
|
- `api-overview.md`: descricao da API, fluxos e responsabilidades atuais
|
|
|
|
Regra de uso durante o refactor:
|
|
1. toda mudanca relevante de arquitetura deve atualizar `refactor-log.md`
|
|
2. quando o comportamento publico mudar, atualizar `api-overview.md`
|
|
3. se a ordem das etapas do refactor mudar, atualizar `refactor-plan.md`
|
|
|
|
Objetivo final:
|
|
- chegar ao fim do refactor com uma base documental suficiente para gerar a documentacao final da API sem depender de reconstruir contexto depois
|