Skip to content

Commit fa406d2

Browse files
committed
Update ADR references
1 parent 87a95d8 commit fa406d2

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/architecture/adr/0033-adopt-mermaid-diagram-standard.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ audience-specific views -- requires substantial rework per audience in practice.
3636

3737
## Decision outcome
3838

39-
Chosen option: **Mermaid with defined conventions**, published as the diagram standard on the
40-
contributing site. The standard is the living reference. Its rules evolve by PR without superseding
41-
this decision and this ADR is superseded only if the chosen option itself changes. A snapshot of the
42-
rules at adoption:
39+
Chosen option: **Mermaid with defined conventions**, published as the
40+
[diagram standard](../../contributing/diagrams.md) on the contributing site. The standard is the
41+
living reference, its rules evolve by PR without superseding this decision and this ADR is
42+
superseded only if the chosen option itself changes. A snapshot of the rules at adoption:
4343

4444
1. Diagrams are Mermaid source text, nothing else: as Mermaid code blocks, or, if in Confluence, via
4545
Macro Pack's Mermaid diagram in text-input mode.
@@ -80,12 +80,12 @@ rules at adoption:
8080

8181
### Plan
8282

83-
[PR #834](https://github.com/bitwarden/contributing-docs/pull/834) publishes the standard at
84-
Contributing › Diagrams and converts the contributing site's existing diagrams (PlantUML/Kroki
85-
sources, static diagram assets, and source-less images) to comply, so the site itself becomes the
86-
reference implementation of the standard. Elsewhere, legacy diagrams convert when their docs are
87-
next touched: images and non-Mermaid sources in repos become Mermaid code blocks, and Confluence
88-
attachments and images become Macro Pack's Mermaid diagram in text-input mode.
83+
The standard is published at Contributing › Diagrams, and the bulk of the contributing site's
84+
existing diagrams (PlantUML/Kroki sources, static diagram assets, and source-less images) have been
85+
converted to comply, so the site becomes the reference implementation of the standard, with the
86+
exceptions noted below. Elsewhere, legacy diagrams convert when their docs are next touched: images
87+
and non-Mermaid sources in repos become Mermaid code blocks, and Confluence attachments and images
88+
become Macro Pack's Mermaid diagram in text-input mode.
8989

9090
The remaining adoption work is delegated to its owners:
9191

0 commit comments

Comments
 (0)