hns-oss-docs-readme-sync

Synchronizes four-locale GitHub README files from a canonical Korean source.

1.2k|222|Updated Sep 16, 2025
One-click install
npx skills add https://github.com/modu-ai/moai-adk --skill hns-oss-docs-readme-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hns-oss-docs-readme-sync
Source: https://github.com/modu-ai/moai-adk/tree/main/.claude/skills/hns-oss-docs-readme-sync
Command: npx skills add https://github.com/modu-ai/moai-adk --skill hns-oss-docs-readme-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining four parallel README files (Korean, English, Japanese, Chinese) in a repository leads to drift: sections fall out of order, translations diverge, and shared elements like the language-switcher header get broken. This Skill defines the exact procedure to keep all four files structurally identical.

Core Features & Use Cases

  • Canonical-first workflow: Author changes in README.ko.md (the primary source), then derive en, ja, and zh versions with minimal diffs in the same PR.
  • Hard contracts and parity checklist: Enforces the shared language-switcher header, identical H2 section counts and order, matching table rows and code blocks, and a URL blacklist check via grep commands.
  • Manual verification recipe: Since no linter exists for READMEs, it provides concrete grep-based checks plus rendering sanity rules (e.g., Mermaid diagrams must use TD/TB direction only).
  • Use Case: A maintainer updates the installation section of an open-source project's README. Following this Skill, they edit README.ko.md first, translate only the changed section into the three derived files, then run the parity checklist before merging.

Quick Start

Update the Korean README.ko.md with your change, derive the English, Japanese, and Chinese files, then run the section-order parity checklist to verify all four files match.

Frequently Asked Questions about hns-oss-docs-readme-sync

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

FAQPage Schema
How do I keep multilingual README files in sync on GitHub?

Designate one locale as canonical (here, Korean README.ko.md) and author all changes there first. Then derive the other locales with minimal diffs in the same PR, and verify parity by comparing H2 section counts and order across all files with grep.

How to translate a README without rewriting unchanged sections?

Translate only the sections that changed in the canonical file, leaving untouched prose as-is. Preserve code blocks, command names, badges, version strings, file paths, and table structure verbatim across all locales.

Is there a linter for checking README translation parity?

No linter exists for README parity in this workflow. Verification is manual: grep for identical H2 counts and ordering, matching code-block and table-row counts, a correct language-switcher header, and a clean URL blacklist check.

What should stay identical across translated README files?

Code blocks, command names, badges, version strings, file paths, table structure, Mermaid diagram direction, and the language-switcher header must remain verbatim. The switcher lists English, 한국어, 日本語, 中文 in fixed order, with the current file's label as plain text.

What are common mistakes when maintaining multi-language READMEs?

Common anti-patterns include editing the English README first instead of the canonical source, re-authoring entire derived files for small changes, altering facts during translation, and dropping the shared language-switcher header during redesigns.