Skip to main content

rstack-docs-writer

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

Source facts

Repository
web-infra-dev/rstest
Last source activity
November 9, 2026 at 12:00
Detected SKILL.md language
English
Stars
514
Forks
42

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
rstack-docs-writer
description
Write or revise Markdown and MDX documentation, including READMEs, guides, and Rspress-based docs.
metadata
{"internal":true}
# Rstack docs writer Follow the project's existing documentation conventions. ## Writing - In usage guides and API/configuration references, explain observable behavior, usage, limits, and required user actions. Include implementation details only when they help users make a choice, configure a feature, or troubleshoot a problem. - Reserve detailed internal mechanisms for architecture/internals documents or explicit requests for implementation explanations. A correct implementation detail is not, by itself, a reason to include it in user documentation. - A compatibility fix does not require a user-facing explanation of its implementation when usage and documented guarantees are unchanged. Keep that rationale in code comments, tests, or the PR description instead. - 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.
View on GitHub