ADR 0034 documentation standard publication - #842
Conversation
| - Follow the MADR structure from the template on the ADR index (`docs/architecture/adr/index.mdx`): | ||
| frontmatter (`adr`, `status`, `date`, `tags`), Context and problem statement, Considered options, | ||
| Decision outcome |
🤖 Bitwarden Claude Code ReviewOverall Assessment: APPROVE Reviewed the publication of ADR-0034 (status flipped to Accepted), the new Code Review Details
No blocking findings. Style-guide self-compliance was checked against the newly published rules |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| audience callout necessary. Every isolated (not directly attached to code) document MUST include an | ||
| audience the document is written for. |
There was a problem hiding this comment.
❓ QUESTION: Does rule 3's audience requirement apply to ADRs?
Context
The ADR template added in this PR (docs/architecture/adr/index.mdx, Format section) has no audience callout, and neither does ADR-0034. ADRs are isolated documents, so as written every ADR on the site is a rule 3 violation — and "Changes to this standard" says existing violations are named, never silently grandfathered.
Either the ADR template carries an audience line, or this section states that ADRs are exempt because the audience is implicit.
withinfocus
left a comment
withinfocus
left a comment
There was a problem hiding this comment.
Where's the CF Pages preview?
| - Follow the MADR structure from the template on the ADR index (`docs/architecture/adr/index.mdx`): | ||
| frontmatter (`adr`, `status`, `date`, `tags`), Context and problem statement, Considered options, | ||
| Decision outcome |
| diffable | ||
| dockerized | ||
| dotfile | ||
| evals |
There was a problem hiding this comment.
⛏️ Leftovers from a content revision perhaps? I don't see any of these in these changes.
d6939b4 to
a98cbc3
Compare
Deploying contributing-docs with
|
| Latest commit: |
6e66afd
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6bf454fc.contributing-docs.pages.dev |
| Branch Preview URL: | https://arch-docs-documentation-stan.contributing-docs.pages.dev |
withinfocus
left a comment
withinfocus
left a comment
There was a problem hiding this comment.
This looks good to me but will wait until the ADR is approved.
3 participants
📔 Objective
Approve and publish unified documentation standard.
Related PRs: