Standardize technical diagrams at Bitwarden - #835
Conversation
(cherry picked from commit bf1e723)
🤖 Bitwarden Claude Code ReviewOverall Assessment: APPROVE This PR adds a single ADR (0033) that adopts a Bitwarden-wide diagram standard: Mermaid source in Markdown, one diagram per audience/intent/scope, sources living beside the docs they illustrate. It is the "ADR only" split from #834. The document follows the established ADR frontmatter and structure conventions, and the new record is auto-listed via Code Review Details
|
Deploying contributing-docs with
|
| Latest commit: |
9a99c83
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f8f36479.contributing-docs.pages.dev |
| Branch Preview URL: | https://arch-adr-documentation-stand-9ffg.contributing-docs.pages.dev |
| ## Decision outcome | ||
|
|
||
| Chosen option: **Mermaid with defined conventions**, published as the | ||
| [diagram standard](../../contributing/diagrams.md). The standard is the living reference. Its rules |
There was a problem hiding this comment.
❓ QUESTION: This links to ../../contributing/diagrams.md, which does not exist in this branch — it is introduced by the sibling PR #834.
Details
The "Decision outcome" frames this link as the standard's "living reference" — the document that actually holds the rules this ADR adopts. In this PR's tree, docs/contributing/diagrams.md is absent, so:
- Docusaurus will emit an
onBrokenMarkdownLinkswarning at build (config iswarn, so the build still passes). - The published ADR will have a dead link until Mermaid ADR approval and site implementation #834 lands.
If #835 is intended to merge before #834, is that ordering acceptable, or should this PR be gated on #834 (or merged together) so the reference resolves on the live site?
ab7953e to
9a99c83
Compare
withinfocus
left a comment
There was a problem hiding this comment.
I can nitpick some language but not a big deal.
📔 Objective
ADR only branch from #834.
(cherry picked from commit bf1e723)
Adopts a Bitwarden-wide diagram standard: Mermaid source in Markdown, one diagram per audience/intent/scope, sources living beside the docs they illustrate.
Motivation (from ADR 0033 in this PR):
📸 Screenshots