MCPInstall

blume-update-docs

Keep a Blume docs site in sync with the product it documents. Audit recently merged pull requests, changelogs, config schemas, CLI help, and public APIs against the docs content, update only pages that are factually stale, verify the docs build, and open (or update) a maintenance pull request — or report a clean no-op. Use when asked to check docs for drift, refresh stale documentation, run a scheduled docs audit, or keep docs current after a release.

Installs
349
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/haydenbleasel/blume --skill blume-update-docs
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads blume-update-docs automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

Update Blume Docs

Blume is a markdown-first documentation framework on Astro/Vite: content lives as Markdown/MDX under a content root (default docs/), navigation derives from the file tree plus optional meta.ts files, blume build validates frontmatter and duplicate routes, and blume validate checks links and anchors.

Your job is docs maintenance, not docs authorship: find where shipped, user-facing behavior has drifted from what the docs claim, fix exactly that, prove the site still builds, and deliver the result as a pull request. A run that finds nothing actionable ends with a short report and no branch, no commit, no PR — prefer a no-op over a noisy PR.

Ground rules

  • Only document what shipped. Never invent features, timelines, pricing, APIs, or compatibility claims. Work behind a feature flag is not ready for docs unless the flag is enabled for the documented audience or the repo explicitly documents unreleased behavior.
  • Facts over polish. Edit when a command, option, default, route, prop, or workflow is wrong or missing. Skip subjective rewording, marketing polish, restructuring, and formatting-only churn.
  • Smallest correct diff. Touch the fewest pages that remove the drift. Preserve the site's voice, frontmatter style, component usage, and meta.ts navigation patterns.
  • Exact source-of-truth wording for commands, flags, config keys, environment variables, routes, and version numbers — copy them from code, don't paraphrase from memory.
  • Respect the repo. Follow AGENTS.md/CLAUDE.md conventions, don't touch generated output (.blume/, dist/), and never overwrite unrelated local changes.

Workflow

  1. Establish context.

    • Read the repo's agent/contributor instructions (AGENTS.md, CLAUDE.md, contribution docs) and honor them.
    • Locate the docs app and content root: blume.config.ts (content.root), the directory of .md/.mdx pages, meta.ts 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.
  2. Reuse or create a maintenance branch.

    • If an open docs-maintenance PR from a previous run exists (head branch starting with blume/), 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.
  3. 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.
  4. Update the docs.

    • Fix the stale pages. Add, rename, or remove meta.ts 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.
  5. Verify.

    • Run the docs build (blume build or the repo's documented docs QA) — it validates frontmatter and duplicate routes.
    • Run blume validate 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.
  6. Deliver.

    • Changes made: commit only the maintenance edits, push the blume/* 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.

Resources

  • references/audit-checklist.md — the source checklist, edit/skip criteria, and Blume-specific editing guidance. Read it before making docs changes.

FAQ

What does the blume-update-docs skill do?

Keep a Blume docs site in sync with the product it documents. Audit recently merged pull requests, changelogs, config schemas, CLI help, and public APIs against the docs content, update only pages that are factually stale, verify the docs build, and open (or update) a maintenance pull request — or report a clean no-op. Use when asked to check docs for drift, refresh stale documentation, run a scheduled docs audit, or keep docs current after a release.

How do I install blume-update-docs?

Run npx skills add https://github.com/haydenbleasel/blume --skill blume-update-docs in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/blume-update-docs/ (personal) or .claude/skills/blume-update-docs/ (project).

Which AI agents can use blume-update-docs?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is blume-update-docs safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains blume-update-docs?

It is published by haydenbleasel in haydenbleasel/blume. It has 349 recorded installs.

More from haydenbleasel/blume

View all →

blume

haydenbleasel/blume

Open the skill to read its SKILL.md instructions.

424 installs

blume-migrate

haydenbleasel/blume

Migrate an existing documentation site (Mintlify, Docusaurus, Fumadocs, Nextra, Starlight, VitePress, VuePress, Docus, MkDocs, mdBook, Fern, GitBook, ReadMe, Redocly, Docsify, Jekyll (Just the Docs), GitHub Wiki, or any docs framework) to Blume, the markdown-first docs framework on Astro. Translate the source config to blume.config.ts, restructure content into Blume's filesystem-derived navigation, rewrite JSX callouts to directives, convert icons to Lucide, and inline snippets. Use when the user asks to migrate/convert/port a docs repo to Blume, or when the repo has a docs.json/mint.json, docusaurus.config., meta.json with fumadocs, meta. with nextra, an astro.config. with starlight(), a .vitepress/config. or .vuepress/config., an mkdocs.yml or zensical.toml, a book.toml (mdBook), a fern/docs.yml, a GitBook .gitbook.yaml/gitbook-docs.yaml, ReadMe order.yaml files in docs/ or reference/, a Redocly sidebars.yaml or @redocly/realm dependency, an index.html that sets window.$docsif

Docs & Writing186 installs

Popular docs & writing skills

View category →

grill-with-docs

mattpocock/skills

A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.

Docs & Writing1.2M installs

lark-markdown

open.feishu.cn

飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。

Docs & Writing778.7K installs

writing-beats

mattpocock/skills

Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.

Docs & Writing490.7K installs

writing-shape

mattpocock/skills

Writing, exploit: shape raw material into an article, paragraph by paragraph.

Docs & Writing490.2K installs

writing-fragments

mattpocock/skills

Writing, explore: mine raw fragments, no structure yet.

Docs & Writing489.6K installs

writing-for-agents

mattpocock/skills

Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.

Docs & Writing479.3K installs