diff --git a/docs/docs/adrs/adr-template.md b/docs/docs/adrs/adr-template.md index 8ecf96596e..20d61a71e3 100644 --- a/docs/docs/adrs/adr-template.md +++ b/docs/docs/adrs/adr-template.md @@ -2,16 +2,16 @@ sidebar_position: 2 title: ADR Template --- -# ADR {ADR-NUMBER}: {TITLE} +# ADR \{ADR-NUMBER}: \{TITLE} ## Changelog -* {date}: {changelog} +* \{date}: \{changelog} ## Status > A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later ADR changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement. -{Deprecated|Proposed|Accepted} +\{Deprecated|Proposed|Accepted} ## Context @@ -38,4 +38,4 @@ If the proposed change will be large, please also indicate a way to do the chang > Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here! -* \{reference link} +* \{references}