chore: condense all docs and markdown files
This commit is contained in:
Vendored
+5
-11
@@ -1,25 +1,19 @@
|
||||
# ADR <NNNN>: <Title>
|
||||
|
||||
## Status
|
||||
|
||||
Proposed | Accepted | Deprecated | Superseded
|
||||
|
||||
## Context
|
||||
|
||||
Explain the problem and the forces at play. Include constraints, risks, or user needs.
|
||||
Problem, constraints, and forces.
|
||||
|
||||
## Decision
|
||||
|
||||
State the decision clearly and explicitly.
|
||||
Chosen option.
|
||||
|
||||
## Consequences
|
||||
|
||||
List the expected positive and negative outcomes, including operational impact.
|
||||
Positive/negative impact, including ops impact.
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
Briefly document viable alternatives and why they were rejected.
|
||||
Viable options and rejection reason.
|
||||
|
||||
## Related
|
||||
|
||||
Link to relevant PRs, runbooks, or architecture sections.
|
||||
Relevant docs/code/runbooks/PRs.
|
||||
|
||||
Reference in New Issue
Block a user