sync-readme

The sync-readme skill is designed for maintainers and developers managing bilingual documentation in Git-based repositories. It automates the complex task of keeping primary English README.md files and their Chinese counterparts (README_ZH.md) in sync. By identifying delta changes, new sections, and outdated segments, the skill ensures that localized documentation never drifts from the original source of truth. It is specifically optimized for technical projects using tools like ai-rules-sync, providing a reliable workflow to bridge the linguistic gap in software manuals, technical specifications, and repository guidelines.

• Automatically detects which language file was updated more recently to determine the synchronization direction.

• Preserves critical technical formatting including code blocks, language badges, table structures, and internal repository links.

• Enforces strict glossary consistency for common engineering terms such as rules (规则), commands (命令), skills (技能), agents (代理), and instructions (指令).

• Maintains identical heading hierarchies and link structures to ensure users can seamlessly toggle between languages using standard documentation navigation.

• Validates completeness to confirm that all features, configuration examples, and supported tool tables are reflected correctly across both language versions.

• The skill assumes that the repository contains both README.md and README_ZH.md in the root directory.

• Users should define a clear source of truth; if both files contain conflicting updates, the skill will prompt the user to intervene.

• For best results, use this skill after completing major feature updates or documentation refactors.

• Input is expected to be a standard GitHub-flavored Markdown repository; output is direct modification or suggestion of the localized README file.

• Note that code examples remain static and are preserved without translation, while prose and interface terminology follow the established translation guidelines to ensure professional and accurate documentation standards.