Blume is a
markdown-first documentation framework on Astro/Vite: content lives as Markdown/MDX under a content root (default
), navigation derives from the file tree plus optional
files,
validates frontmatter and duplicate routes, and
checks links and anchors.
-
Establish context.
- Read the repo's agent/contributor instructions (, , contribution docs) and honor them.
- Locate the docs app and content root: (), the directory of / pages, files, and the package manager + docs build command.
- If this run was configured with a trigger, lookback window, docs path, target branch, or PR policy, honor those. Use the defaults below only where the prompt is silent.
-
Reuse or create a maintenance branch.
- If an open docs-maintenance PR from a previous run exists (head branch starting with ), check out and update that branch instead of opening a duplicate.
- Otherwise branch from the default branch as
blume/docs-refresh-YYYY-MM-DD
. Create the branch only once you know an edit is needed.
-
Find drift. Read
references/audit-checklist.md
for the full source list and change criteria, then:
- Review PRs merged into the default branch within the lookback window (default: the last 7 days) and extract the user-facing changes.
- Compare those changes — plus changelogs, release notes, config schemas, exported APIs, CLI help, and examples — against the docs content.
- Check external links only when a checked page depends on them; prefer official docs and release notes over secondary sources.
- Keep notes: what you checked, what changed upstream, and why each edit is (or isn't) needed.
-
Update the docs.
- Fix the stale pages. Add, rename, or remove entries when pages are added, renamed, or deleted.
- Match the surrounding pages: frontmatter shape, Blume components already in use, code-fence style, root-relative internal links.
-
Verify.
- Run the docs build ( or the repo's documented docs QA) — it validates frontmatter and duplicate routes.
- Run to check internal links and anchors.
- Run lint/format/typecheck when the repo's conventions call for them on docs changes.
- Fix failures your edits caused; report pre-existing failures separately instead of fixing them in this PR.
-
Deliver.
- Changes made: commit only the maintenance edits, push the branch, and open or update a PR against the default branch titled like
blume: refresh docs for YYYY-MM-DD
. In the body list sources checked, docs changed, verification commands and results, skipped checks, and residual risk.
- No changes needed: report the PRs and docs areas checked and the no-op result. Do not create a branch, commit, or PR.