doc-writer
Write, review, and organize the human-authored prose around a generated API reference on an rspress-plugin-api-extractor site. Use when authoring or editing a guide, concept, example, or package-overview page; deciding a site's information architecture and sidebar mount (guides spine + overview + generated api tree); setting page frontmatter (title, one-sentence description); deciding whether a code snippet earns a with-api fence versus a plain fence; writing a migration note for a breaking API change; cross-linking prose into the generated reference; or running an editorial review of a docs site. Do NOT use for the mechanics inside a with-api fence — notation, @errors, ---cut---, why a block will not compile (see twoslash); for ApiExtractorPlugin configuration, routes, theming or model plumbing (see plugin-config); or for generic RSPress routing, _nav.json, components, or frontmatter fields beyond title/description (see rspress-core).
Pinned to revision f3ac0940b75a, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/doc-writer/SKILL.md
- skills/doc-writer/references/cross-linking.md
- skills/doc-writer/references/page-skeletons.md
- skills/doc-writer/references/review-rubric.md
- skills/doc-writer/references/sync-workflow.md
Every link opens the file at its source, pinned to the revision this page describes.