translate-doc-zh

Translates English Markdown documentation into matching Chinese documents under docs/zh.

5.7k|588|Updated Feb 24, 2025
One-click install
npx skills add https://github.com/inclusionAI/AReaL --skill translate-doc-zh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: translate-doc-zh
Source: https://github.com/inclusionAI/AReaL/tree/main/.agents/skills/translate-doc-zh
Command: npx skills add https://github.com/inclusionAI/AReaL --skill translate-doc-zh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining bilingual documentation is tedious and error-prone: translators often break Markdown structure, mistranslate technical terms, or accidentally translate code blocks and configuration keys. This Skill automates the translation of English docs under docs/en/ into their Chinese counterparts under docs/zh/ while preserving formatting and terminology.

Core Features & Use Cases

  • Path Validation and Resolution: Verifies the source file exists under docs/en/ with a .md extension, then maps it to the corresponding docs/zh/ target path, creating directories when needed.
  • Incremental or Full Translation: Updates only changed sections when a Chinese version already exists, or translates the entire document when it does not.
  • Terminology and Format Preservation: Keeps technical terms (FSDP, GRPO, PPO, vLLM, SGLang, etc.), file paths, code blocks, CLI flags, and config keys untranslated while preserving Markdown structure and tables.
  • Use Case: After updating an English tutorial in docs/en/tutorial/agentic_rl.md, run this Skill to produce a synchronized Chinese version in docs/zh/tutorial/agentic_rl.md without manual copy-editing.

Quick Start

Translate the document docs/en/tutorial/agentic_rl.md into Chinese and write it to the matching path under docs/zh.

Frequently Asked Questions about translate-doc-zh

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I translate English Markdown docs to Chinese automatically?

Provide the path of a Markdown file under docs/en and the Skill validates it, resolves the matching docs/zh target path, and translates the content. Existing Chinese files are updated incrementally; missing ones are translated in full.

How to keep code blocks and technical terms untranslated in documentation translation?

The Skill preserves code blocks, file paths, CLI flags, and configuration keys verbatim, and keeps technical terms like FSDP, GRPO, PPO, vLLM, SGLang, PyTorch, and HuggingFace in English while translating surrounding prose.

Can I update only changed sections of an already translated document?

Yes. When the Chinese target file already exists, the Skill updates only the changed parts and preserves the rest, avoiding a full re-translation of unchanged sections.

What happens if the docs/zh target directory does not exist?

The Skill creates the missing target directory before writing the translated file, so nested paths under docs/zh are handled without manual setup.

What are the limitations of automated documentation translation?

The Skill only accepts Markdown files located under docs/en and rejects other paths. Translation quality depends on the underlying language model, so domain-specific phrasing may still benefit from human review.