Repository navigation
docs: replace the ADRs with one decisions document - #31
Merged
Merged
Conversation
docs/decisoes-de-arquitetura.md will replace the 33 ADRs with about fifteen decisions, each answering the same six questions, in Portuguese because it is also the owner's study material. This first block covers the platform, the layers, the domain model, endpoints, handlers, validation, errors, mapping and the API reference. The owner reviewed three of them and kept Minimal APIs, the validation decorator and the handler interfaces. The comment convention agreed in the same review goes into the coding conventions.
Remove docs/adr (33 ADRs, their index and template); the decisions now live in docs/decisoes-de-arquitetura.md and stay in the git history. Point AGENTS.md, the READMEs, CONTRIBUTING, the docs index, the agent guides, the levantar-issue skill and the feature template at the new document. Rewrite record-a-decision.md as a short procedure for it. Fix the testing guide: no Mailpit, no mock library, and account-flow cases that match the temporary-password design instead of activation links. Align the architecture guide and the environment guide with the scope decisions of 2026-10-05 (no e-mail, no permission cache).
Remove the ADR citations from comments in C#, csproj, props, .http, Dockerfile, .editorconfig and the CI workflow. Business rule IDs stay. Only comment text changes; no behavior and no CI step is touched. Correct three comments that described things that do not exist: the e-mail implementation in Infrastructure, Mailpit in the integration tests project, and a delivery pipeline in the CI workflow.
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.
What
Starts
docs/decisoes-de-arquitetura.md, the single document that will replace the 33 ADRs. Draft: only the first of four blocks is written.When the four blocks are in, this pull request also deletes
docs/adr/, repoints the documents that cite ADRs and rewrites the code comments that cite them.Why
The owner must be able to explain every decision of the project. Thirty-three records with metadata are out of proportion for the current size; one document with about fifteen decisions, each answering the same six questions, is something a junior developer can study and defend. It is in Portuguese because it is the owner's study material.
Decisions the owner took while reviewing block A:
docs/agents/guides/coding-conventions.md).Tests
Documentation only: there is no numbered test list.
How to test
Read
docs/decisoes-de-arquitetura.md. A script checked every relative link in the Markdown files: none broken.Checklist
check.ps1passes locally: to run before this leaves draft