Parent roadmap: rodri-oliveira-dev/rodri-oliveira-dev#30
Contexto
O README contém documentação técnica rica, porém acumula onboarding, contrato público, arquitetura, garantias, observabilidade, extensibilidade e manutenção em um único fluxo longo.
A meta não é remover profundidade, e sim permitir que um consumidor entenda e experimente a biblioteca rapidamente antes de entrar nos detalhes.
Escopo
- Preservar no README principal:
- propósito e problema;
- garantias e limites essenciais;
- instalação;
- Quick Start executável;
- exemplo mínimo de DI/dispatcher;
- links claros para documentação aprofundada.
- Mover ou consolidar detalhes extensos em
docs/ quando já existir local adequado:
- modelo de entrega e leases;
- retry/classificação;
- segurança/assinatura;
- observabilidade;
- implementação de stores;
- operação em produção;
- extensibilidade.
- Criar uma pequena seção "Read next" / "Documentation map".
- Não esconder a garantia at-least-once nem sugerir exactly-once.
- Manter explícito que durabilidade real depende de store durável fornecido/configurado pelo consumidor.
Definition of Done
Parent roadmap: rodri-oliveira-dev/rodri-oliveira-dev#30
Contexto
O README contém documentação técnica rica, porém acumula onboarding, contrato público, arquitetura, garantias, observabilidade, extensibilidade e manutenção em um único fluxo longo.
A meta não é remover profundidade, e sim permitir que um consumidor entenda e experimente a biblioteca rapidamente antes de entrar nos detalhes.
Escopo
docs/quando já existir local adequado:Definition of Done
docs/.