docs: README deixa de exigir o diagrama ER - #10
Merged
Merged
Conversation
O README é a vitrine do projeto; o diagrama ER mora só no docs/architecture.md, e o README aponta para ele. Uma cópia no README teria de ser mantida em dois lugares a cada mudança do modelo. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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
1 participant
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 este PR faz e por quê
Tira da ficha (
docs/checklist.md, Regras da disciplina) a exigência de o README trazer o diagrama ER em Mermaid renderizado. O README é a vitrine do projeto: o que é, quem fez, como rodar, onde está o protótipo e o site. O diagrama ER é conteúdo técnico e já tem casa própria, o §5.2 dodocs/architecture.md, que o README continua linkando.Manter uma cópia no README obrigava a equipe a atualizar o modelo em dois lugares a cada mudança, e era a única duplicação que o método tolerava. Com a mudança, o
docs/architecture.md§5.2 e odocs/guia-sdd.mddeixam de dizer que o diagrama "vai renderizado no README".Apontamentos da revisão
não se aplica
🤖 Generated with Claude Code