Skip to main content

ADR-001: Metadata & Frontmatter Standard

Context

The documentation portal is built with Docusaurus, which requires YAML frontmatter to correctly render page titles, slugs, and navigation. Additionally, for a distributed team (human/AI), tracking the manual or agentic modification date is critical for relevance auditing.

Decision

  1. Each .md file MUST start with a YAML frontmatter block.
  2. Every modification to a file MUST update the last_modified field in the frontmatter.

Consequences

  • Positive: Automated build reliability, clear documentation history, and easier audit of "stale" documents.
  • Manual Overhead: Requires discipline to update the date (mitigated by Agentic rules).