Skip to content

docs: reescreve o readme - #23

Merged
thnbi merged 11 commits into
devfrom
docs/enxuga-o-readme
Sep 17, 2026
Merged

thnbi merged 11 commits into
devfrom
docs/enxuga-o-readme

Conversation

@thnbi

@thnbi thnbi commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

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 os
dois PRs ficou pendurado.

Como testar

  • Conferir que todo link resolve: DEPLOY, openapi.yaml, ADRs, docs e LICENSE
  • Rodar docker compose up e conferir que sobe em localhost:8080

Auto-review (checklist)

  • Descrição clara (o que/por quê/como testar)
  • PR pequeno e focado
  • Casos limite considerados (ex.: vazio, 0, erro)
  • Evidência de teste (manual ou automatizado)

@thnbi thnbi self-assigned this Sep 16, 2026
@thnbi thnbi added the documentation Improvements or additions to documentation label Sep 16, 2026
@thnbi thnbi added the isn Disciplina ISN 75620501, edicao 2026.2 label Sep 17, 2026
@thnbi thnbi changed the title docs: enxuga o readme para o essencial docs: reescreve o readme Sep 17, 2026

@NicolasArthurDev NicolasArthurDev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrigi o conflito. LGTM

@thnbi
thnbi merged commit 1816163 into dev Sep 17, 2026
2 checks passed
@thnbi
thnbi deleted the docs/enxuga-o-readme branch September 17, 2026 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation isn Disciplina ISN 75620501, edicao 2026.2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants