Skip to main content

Repository Guide

This documentation site is governed by the rules and conventions defined in sv0-documentation/CLAUDE.md. That file is the canonical source of truth for documentation structure, naming, and navigation requirements.

Required Conventions​

  • mkdocs.yml is the authoritative navigation manifest.
  • Every document must include an @ai-metadata block.
  • File naming must use lowercase with hyphens.
  • Each folder must include an index.md landing page.
  • Architecture docs use numbered prefixes for ordering (00-, 01-, etc.).
  • ADRs use adr-NNN-short-title.md naming.

When In Doubt​

If any guidance here conflicts with other notes, defer to sv0-documentation/CLAUDE.md and update affected docs or navigation accordingly.