From 8cd56756a683b77cd3e163da6b3e76efc757f724 Mon Sep 17 00:00:00 2001 From: neverland Date: Thu, 8 Oct 2026 13:31:19 +0800 Subject: [PATCH 1/2] docs: clarify overview description guidance --- .agents/skills/rstack-docs-writer/SKILL.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.agents/skills/rstack-docs-writer/SKILL.md b/.agents/skills/rstack-docs-writer/SKILL.md index b339cf8..5758c26 100644 --- a/.agents/skills/rstack-docs-writer/SKILL.md +++ b/.agents/skills/rstack-docs-writer/SKILL.md @@ -21,6 +21,7 @@ Follow the project's existing documentation conventions. 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. +- For overview pages, state the overall purpose first, then use representative examples without implying an exhaustive list of supported features. - 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. From d5a1b7ae3771a58a6d0cbab05f0658d8c894d019 Mon Sep 17 00:00:00 2001 From: neverland Date: Thu, 8 Oct 2026 13:41:03 +0800 Subject: [PATCH 2/2] docs: generalize page description guidance --- .agents/skills/rstack-docs-writer/SKILL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.agents/skills/rstack-docs-writer/SKILL.md b/.agents/skills/rstack-docs-writer/SKILL.md index 5758c26..fcbf0ee 100644 --- a/.agents/skills/rstack-docs-writer/SKILL.md +++ b/.agents/skills/rstack-docs-writer/SKILL.md @@ -21,7 +21,7 @@ Follow the project's existing documentation conventions. 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. -- For overview pages, state the overall purpose first, then use representative examples without implying an exhaustive list of supported features. +- State the overall purpose first. When using examples to clarify scope, make clear that they are representative, not exhaustive. - 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.