Roadmap conventions

Closed status enum for milestone and phase frontmatter; how to validate with the repo guard script.

Roadmap conventions

Frontmatter status enum (closed)

Every roadmap MDX page that declares status in YAML frontmatter must use one of:

ValueMeaning
completedWork merged and accepted (exit audits / PRs)
plannedSpecified; not started
in-progressActive implementation branch
supersededReplaced by another milestone or ADR; keep for history

Do not invent values such as Complete, done, wip, or deferred in the status field. Human-readable badges in the body may say "Complete" while frontmatter stays completed.

Validation

bash
python infra/scripts/check_roadmap_status.py

Wired into make repo-guards (via infra/scripts/dev-tool.sh). The script scans web/content/roadmap/**/*.mdx for frontmatter status: and exits non-zero on unknown values. Pages without a status key are skipped.

Edit on GitHub

Last updated on

On this page

0%