docs: reescreve o readme - #23
Merged
Merged
Conversation
NicolasArthurDev
approved these changes
Sep 17, 2026
NicolasArthurDev
left a comment
Contributor
There was a problem hiding this comment.
Corrigi o conflito. LGTM
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
O que mudou
Um arquivo, 21 linhas entrando e 53 saindo.
Saíram oito seções: Equipe, MVP, MVP entregue, Governança, DoD, Critérios de Qualidade, Fluxo
de trabalho e Arquitetura.
Entrou a descrição do projeto, que antes não existia em lugar nenhum de forma utilizável. A
abertura diz o que o sistema é, o que o servidor faz, o que a busca entrega e que agente de IA
tem o mesmo acesso que uma pessoa. Sobraram três seções curtas: como rodar, onde está a
documentação e qual a licença.
Por quê
O README era índice de processo interno. Equipe, DoD e governança são combinados do time, não
ajudam quem chega de fora, e vivem melhor em CONTRIBUTING ou na documentação. O recorte do MVP
descrevia um sistema que os ADRs 0012 a 0031 substituíram, incluindo hierarquia por pastas e
controle de versões, que hoje são decisões revertidas. E cada link de processo tinha ganhado
uma seção só para ele.
A descrição era o buraco maior. Os três parágrafos de abertura falavam de arquitetura
centralizada e simbiose com agentes, sem dizer o que o sistema faz. Quem abria o repositório
não descobria que markupp organiza a base sozinho, que a busca encontra por sentido, nem que
cliente é qualquer programa que leia ou escreva notas.
A licença passou a aparecer, o que não acontecia apesar do arquivo existir desde o ADR-0008. E
a documentação da API, que a disciplina exige, ganhou um ponteiro.
Relação com o #18
Os dois mexem no README e vão conflitar. A resolução é ficar com esta versão, decidindo na hora
se o índice dos cinco documentos da especificação entra na seção Documentação ou fica só dentro
de docs.
Não há mais dependência de ordem. A abertura daqui carrega o texto que morava em
docs/resumo.md, arquivo que o #18 remove justamente por duplicá-la, e nenhum link entre osdois PRs ficou pendurado.
Como testar
docker compose upe conferir que sobe em localhost:8080Auto-review (checklist)