Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.84 KB

File metadata and controls

33 lines (20 loc) · 1.84 KB

Code and doc quality

Short rules so "done" is consistent and docs don't rot.

Docs as code

  • Docs are PR-reviewed, versioned, and follow the Diátaxis layout.
  • Docs/examples must be copy/paste safe: no smart quotes, NBSP, or typographic dashes in command blocks; use ASCII equivalents. See recurring_loops.md § Curly quotes / special characters.
  • "Done" includes doc updates when behavior, interfaces, or config change: update or add one doc (how-to, reference, or explanation); add See also / Related ADRs. See current_task.md § Docs.
  • Doc gaps out of scope → file in opportunities.md (operability/maintainability).
  • Conventions: docs/_meta/linking.md (relative links, frontmatter, See also on every doc).
  • If docs added: run link check when available (or N/A). Sets the norm even if not wired in CI yet.

Verification

Git workflow

Performance and resources

Safety and orientation

Security