From c2d324c0a70cede2fe30a7f02d7757fb84a51aa9 Mon Sep 17 00:00:00 2001 From: neverland Date: Tue, 10 Feb 2026 22:12:57 +0800 Subject: [PATCH 1/2] docs: add docs-en-improvement skill and remove old prompt file --- .agents/skills/docs-en-improvement/SKILL.md | 24 +++++++++++++++++ .github/docs-en-improvement.prompt.yml | 30 --------------------- 2 files changed, 24 insertions(+), 30 deletions(-) create mode 100644 .agents/skills/docs-en-improvement/SKILL.md delete mode 100644 .github/docs-en-improvement.prompt.yml diff --git a/.agents/skills/docs-en-improvement/SKILL.md b/.agents/skills/docs-en-improvement/SKILL.md new file mode 100644 index 0000000000..6b68441a17 --- /dev/null +++ b/.agents/skills/docs-en-improvement/SKILL.md @@ -0,0 +1,24 @@ +--- +name: docs-en-improvement +description: Improve English documentation under `website/docs/en` by rewriting unnatural translated sentences into clear, professional English while preserving meaning. Use when editing or polishing English docs. +--- + +# Docs En Improvement + +## Steps + +1. Focus on files in `website/docs/en`. + +2. Rewrite only sentences that clearly improve clarity, correctness, or naturalness in English. + +3. Preserve original meaning exactly; do not introduce new claims or remove technical details. + +4. If a file in `docs/en` is updated, check the mirrored file in `website/docs/zh` and apply equivalent updates when needed. + +## Constraints + +- Limit each PR to 10 documentation files or fewer. +- Start PR titles with `docs:`. +- Keep reasonable technical abbreviations (for example, `dev server`). +- Keep wording simple and readable for non-native English readers. +- Use sentence case for Markdown headings. diff --git a/.github/docs-en-improvement.prompt.yml b/.github/docs-en-improvement.prompt.yml deleted file mode 100644 index 5605a98b28..0000000000 --- a/.github/docs-en-improvement.prompt.yml +++ /dev/null @@ -1,30 +0,0 @@ -messages: - - role: system - content: >- - Improve the English docs in `website/docs/en`. Many paragraphs were - translated from Chinese and may sound unnatural. - - - Rewrite sentences that don't read like authentic, professional English — - **without changing their meaning** — so they match the tone of - high-quality open-source docs. - - - - **IMPORTANT:** Only change a sentence if it clearly improves clarity or - correctness. - - - **IMPORTANT:** Don't alter the original meaning. - - - If you edit files in `docs/en`, check the same files in `docs/zh` to see - if similar updates are needed. - - - Use clear, simple language for non-native English readers. - - - Keep reasonable technical abbreviations (e.g., `dev server`). - - - Use sentence case for Markdown headings. - - - Don't change more than 10 files in one PR. - - - Start PR titles with `docs:`. -model: openai/gpt-5 From 2b4ec170df60a8f921aa14abdeee20cdb87ceaef Mon Sep 17 00:00:00 2001 From: neverland Date: Tue, 10 Feb 2026 22:15:45 +0800 Subject: [PATCH 2/2] Update .agents/skills/docs-en-improvement/SKILL.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- .agents/skills/docs-en-improvement/SKILL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.agents/skills/docs-en-improvement/SKILL.md b/.agents/skills/docs-en-improvement/SKILL.md index 6b68441a17..5be1fb6d84 100644 --- a/.agents/skills/docs-en-improvement/SKILL.md +++ b/.agents/skills/docs-en-improvement/SKILL.md @@ -13,7 +13,7 @@ description: Improve English documentation under `website/docs/en` by rewriting 3. Preserve original meaning exactly; do not introduce new claims or remove technical details. -4. If a file in `docs/en` is updated, check the mirrored file in `website/docs/zh` and apply equivalent updates when needed. +4. If a file in `website/docs/en` is updated, check the mirrored file in `website/docs/zh` and apply equivalent updates when needed. ## Constraints