Contributing

Docs Style Guide

Docs Style Guide

Required Frontmatter

Every page must include:

  • title
  • summary
  • audience
  • status
  • last_verified
  • source_of_truth
  • related_artifacts

Writing Rules

  • Prefer task-first, operationally actionable structure.
  • Keep architecture claims tied to code or validated artifacts.
  • Mark historical pages as archived snapshots.
  • Use relative internal links.
  • Keep links stable and validated in CI.