Skip to main content

rstack-docs-writer

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

ソース情報

リポジトリ
web-infra-dev/rspack
ソースの最終更新活動
2026年9月12日 22:26
検出された SKILL.md の言語
英語
スター
12,976
フォーク
882

インストール方法

デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。

ソースファイルを確認

インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。

SKILL.md を表示中

SKILL.md
ソースの指示 · 読み取り専用プレビュー
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 - 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.
GitHubで見る