Skip to content

Commit 17c4a81

Browse files
committed
wrap filename references in ``
1 parent 2f0b8a4 commit 17c4a81

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/architecture/adr/0034-adopt-engineering-documentation-standard.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Documentation practice has fragmented as the organization has grown:
2222
- Stale content accumulates with no supersession discipline, leaving superseded pages beside current
2323
ones with no deprecation.
2424
- AI agents have become first-class documentation consumers and maintainers, and their instruction
25-
files (CLAUDE.md, rules, and skills across all repos) accumulate documentation-like content with
25+
files (`CLAUDE.md`, rules, and skills across all repos) accumulate documentation-like content with
2626
nothing defining whether they are documentation at all.
2727

2828
A 2026-07 audit classified every documentation artifact across the major repos, this site, and
@@ -80,10 +80,10 @@ Follow-up PRs complete the standard:
8080
- The standard, with its format guidance and templates, publishes as the Documentation section under
8181
Contributing and becomes the living reference this ADR mandates.
8282
- The doc-currency plugin, which enforces rule 4, publishes in
83-
[bitwarden/ai-plugins](https://github.com/bitwarden/ai-plugins) and distributes the root CLAUDE.md
84-
documentation obligations.
85-
- Each repo adopts the standard: base documentation obligations in the root CLAUDE.md, a
86-
CONTRIBUTING pointer, and markdown tooling parity.
83+
[bitwarden/ai-plugins](https://github.com/bitwarden/ai-plugins) and distributes the root
84+
`CLAUDE.md` documentation obligations.
85+
- Each repo adopts the standard: base documentation obligations in the root `CLAUDE.md`, a
86+
`CONTRIBUTING` pointer, and markdown tooling parity.
8787
- Remediation work items are filed for every rule that current reality violates, and the superseded
8888
Confluence standards page is deleted.
8989

0 commit comments

Comments
 (0)