docs: add YAML frontmatter to all docs/ markdown files#571
Merged
Conversation
Create tools/add_frontmatter.py that scans docs/ for markdown files and prepends standardized YAML frontmatter with doc_id, title, version, date, status, project, and category fields. The script infers category from filename patterns and generates sequential doc_id values per category. Idempotent — skips files that already have the standardized frontmatter block.
Add standardized YAML frontmatter metadata to 84 markdown files in
docs/. Each file gets a unique doc_id (COM-{CATEGORY}-{NNN}), title,
version, date, status, project, and category. Categories inferred
from filename patterns: ARCH, API, GUID, PERF, MIGR, PROJ, FEAT,
QUAL, SECU, INTR, ADR.
Closes #562 (common_system portion)
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
* docs(tools): add frontmatter generation script
Create tools/add_frontmatter.py that scans docs/ for markdown files
and prepends standardized YAML frontmatter with doc_id, title,
version, date, status, project, and category fields. The script
infers category from filename patterns and generates sequential
doc_id values per category. Idempotent — skips files that already
have the standardized frontmatter block.
* docs: add YAML frontmatter to all docs/ markdown files
Add standardized YAML frontmatter metadata to 84 markdown files in
docs/. Each file gets a unique doc_id (COM-{CATEGORY}-{NNN}), title,
version, date, status, project, and category. Categories inferred
from filename patterns: ARCH, API, GUID, PERF, MIGR, PROJ, FEAT,
QUAL, SECU, INTR, ADR.
Closes #562 (common_system portion)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #562
Summary
tools/add_frontmatter.pyscript that scansdocs/for markdown files and prepends standardized YAML frontmatterdocs/doc_id(COM-{CATEGORY}-{NNN}), title, version, date, status, project, and categoryFrontmatter Schema
Category Breakdown (84 files)
Test Plan