Documentation Agent

The Documentation Agent keeps your docs up to date by scanning recent repository changes and generating audience-aware MDX files:

• Developer docs with API surfaces, code examples, and technical notes.
• User docs with feature overviews and how-to guides.
• Changelog entries summarizing what changed.

How it works

1. Diff: Compare base..head to extract changed files and a combined patch.
2. Summarize: Heuristics + AI-ready summary scaffolding produce titles, bullets, and a short narrative.
3. Write MDX: Generate MDX with frontmatter under content/docs/{developer|user|changelog}/.
4. Propose PR: Open a PR with docs changes and apply labels like documentation.
5. Trigger Build: Optionally trigger a documentation workflow (e.g. GitHub Actions) to preview changes.

MDX Frontmatter

Each doc includes structured metadata for search and retrieval:

id: "dev-feature-x" type: "developer" # developer | user | changelog level: 0 # 0=raw, 1=summary, 2=meta title: "API and UI updates · PR #123" date: "2025-09-06" tags: ["developer", "docs"] ticket: "TCK-234" pr: 123

API

See API → Docs: Generate to generate drafts from diffs, optionally open a PR, and trigger a docs workflow.