Skip to content

Documentation Source of Truth Policy

The Flow of Truth

Codebase -> Implementation -> Documentation

  1. Code is the ultimate source of truth. Documentation must describe the current implementation.
  2. If documentation conflicts with the code, the documentation is considered outdated and must be updated.
  3. Do not silently change application behavior to match documentation unless explicitly approved as a bug fix.
  4. Flag any discovered inconsistencies during documentation audits.

  5. "Planned" or "Partial" features must be strictly designated with MkDocs Material admonitions, not GitHub alert syntax:

    !!! warning
    This feature is planned but not fully implemented.

    The body must be indented by four spaces. GitHub's > [!WARNING] form renders as a plain blockquote on this site.

Last Updated: 2026-10-11