blume-write-skill

Installation
SKILL.md

Write a docs site's agent skill

Every Blume site already publishes a generated skill at /skill.md: a map of its pages with their one-line descriptions, built without a model. It tells an agent where things are, not how the product works. Your job is to write the skill that does: what the product is, how to set it up, the concepts and tasks that matter, and where it bites, with every topic linked to the page that covers it.

The reader is a coding agent working in someone else's project. It loaded your skill because a task touches this product, and it needs to act correctly without reading the whole site first.

Ground rules

  • Only what the docs say. Every claim, command, config key, flag, environment variable, and code sample must come from a page in the content root, copied rather than paraphrased. Never fill a gap from memory or from what similar products do. Where the docs don't answer something the skill needs, leave it out and list it in your report as a docs gap.
  • One file. Keep it a lone SKILL.md: no references/, scripts/, or assets/. A single file is what the site serves at /skill.md and what an agent can fetch in one request. Depth lives in the docs, so link to them instead of copying them in.
  • Absolute links to Markdown. Link pages as <site><route>.md (the home page is <site>/index.md), using the site URL your prompt gives. Link only pages that exist: a page's route is its path under the content root without the extension, and a folder's index page takes the folder's route.
  • Keep the given name. The frontmatter name must be exactly the one in your prompt. That match is what makes your skill replace the generated one.
  • Short beats complete. Aim for well under 300 lines. Skip anything a capable agent already knows (general programming, Markdown, how HTTP works) and anything it can look up from a link when it needs it.

Workflow

  1. Read the docs. Start with blume.config.ts (the site's title, description, content.root, navigation, API references) and the meta.ts files, which give the sidebar order. Then read the home page, the quickstart or installation page, each core-concept page, the configuration reference, the API reference overview, and any troubleshooting or FAQ pages. If the site has been built, its llms.txt lists every page with its description.
Installs
27
GitHub Stars
1.8K
First Seen
Sep 27, 2026