Ugrás a fő tartalomra

ADR-003: Structural Separation of Canonical and Generated Knowledge

  • Status: Accepted
  • Date: 2026-08-12

Context & Problem Statement​

AI generation must never launder unverified hallucinations into canonical engineering documentation. Merely using naming conventions or warning callouts is fragile and easily bypassed by editors or automated tools.

Decision​

Enforce a physical, structural separation using two distinct plugin instances:

  1. Canonical Plane: Located in docs/source/**, served at route /docs. Only human PRs may touch this directory.
  2. Generated Plane: Located in docs/generated/**, served at route /views. Automated generation tools write only here.
  3. Unidirectional Link Rule: Generated views may cite canonical pages; canonical pages never cite generated views (except from a designated Views directory index).