write-docs
Create or revise documentation for the simple-stack repository, especially MDX guides and API reference content under www/src/content/docs/. Use when asked to write docs, restructure guides, add examples, or enforce documentation tone, structure, and code highlighting conventions.
来源信息
- 仓库
- bholmesdev/simple-stack
- 最近来源活动
- 2026年2月1日 19:02
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 459
- Forks
- 9
安装方式
默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。
检查来源文件
决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。
文件资源管理器
2 个文件正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- write-docs
- description
- Create or revise documentation for the simple-stack repository, especially MDX guides and API reference content under www/src/content/docs/. Use when asked to write docs, restructure guides, add examples, or enforce documentation tone, structure, and code highlighting conventions.
# Write Docs
## Overview
Write clear, progressive documentation for this repository using the existing Starlight + MDX docs setup. Favor stepwise examples, explicit usefulness, and consistent tone.
## Workflow
1. Locate the target doc or create a new MDX file under `www/src/content/docs/`.
2. Follow the style reference in `references/docs-style.md`.
3. Start each feature or API section with: what it does, why it is useful, then an example.
4. Build examples incrementally (naive first, then improvements and features).
5. Use Starlight code line highlighting (`ins`, `del`, `{n-m}`) to emphasize changes while keeping full context.
6. Keep guide content and API reference content clearly separated by headings or separate docs.
## House style essentials
- Use second-person voice and consistent terminology.
- Avoid emojis, slang, or playful narration.
- Prefer short, direct sentences and descriptive headings.
## References
- Read `references/docs-style.md` for the full style guide and code highlighting examples.
在 GitHub 查看