rstack-docs-writer

v2026.09.24

Write or revise Markdown and MDX documentation, including READMEs, guides, and Rspress-based docs.

GitHub
Install command
npx skhub add rstackjs/rstack-docs-writer
Markdown
SKILL.md

Rstack docs writer

Follow the project's existing documentation conventions.

Writing

  • Explain user-facing behavior concisely, adding details and examples only when they help users configure or use the feature.
  • Keep common abbreviations such as dev server.
  • Keep documentation in sync across locales when changing content. Use English as the default language unless the project specifies another.
  • Use sentence-case headings.

Heading anchors

  • Prefer Rspress's default anchors for headings in the default locale; preserve intentional existing custom IDs.
  • Determine generated anchors from heading id attributes: run the project's docs dev command and inspect the rendered browser DOM, or run its docs build command and inspect the generated HTML.
  • Match headings in other locales to the default locale's anchors, using the project's locale mapping to pair pages. Add custom IDs where defaults differ; remove redundant IDs only if anchors stay unchanged.
  • Escape custom IDs in MDX: ## Localized heading \{#default-locale-anchor}.
  • When anchors change, update corresponding IDs across locales and affected Markdown links and JSX href attributes. Check target pages before replacing hashes.
  • Check changed links against their target headings.
Discovery
Tags

No tags published for this skill.

Version
Latest version metadata

Version

v2026.09.24

Published

Sep 24, 2026

Category

Uncategorized

License

MIT

Source path

.agents/skills/rstack-docs-writer

Default branch

main

Latest commit

1ccaad5

Tree SHA

05c93b7