OpenParable
Skip to content
← Back to skills

Sync Zh En Docs

Documents
sync-zh-en-docs

Sync Zh En Docs is an Agent Skill for documents published in the web-infra-dev/rsbuild repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Sync uncommitted docs between `website/docs/zh` and `website/docs/en`. Use when authors update docs in one language and need to align the mirrored `.md`/`.mdx` file in the other language.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/web-infra-dev/rsbuild/blob/HEAD/.agents/skills/sync-zh-en-docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/sync-zh-en-docs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Sync Zh/En Documentation

Steps

  1. Check uncommitted changes under website/docs/zh and website/docs/en.

  2. Translate each changed file to the counterpart path (zh <-> en), and keep:

  • meaning and structure consistent
  • technical terms / commands / code blocks unchanged unless localization is required
  • concise, clear, professional technical-doc style
  1. Format and verify:
node --run format