Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .agents/skills/rstack-docs-writer/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ Follow the project's existing documentation conventions.
- Keep documentation in sync across locales when changing content. Use English as the default language unless the project specifies another.
- Use sentence-case headings.

## Page descriptions

Page frontmatter `description` is reused in search metadata and `llms.txt`.

- Summarize the page's actual scope using concrete APIs, tasks, and distinguishing topics, rather than one paragraph or example.
- Distinguish related configuration and API pages. Include version, stability, or environment constraints when they affect applicability.
- Use one complete plain-text sentence. Avoid generic templates, unsupported claims, truncation, and padding to meet a character count.
- Match the page's language and keep descriptions equivalent across locales.

## Heading anchors

- Prefer Rspress's default anchors for headings in the default locale; preserve intentional existing custom IDs.
Expand Down
Loading