hns-oss-docs-readme-sync

Featured

README 4-file synchronization procedure for the oss-docs harness: Korean README.ko.md as primary source, en/ja/zh derivation, the shared language-switcher header contract, section-order parity checklist, and the manual verification recipe (no linter exists for READMEs). Loaded by the content-author and locale-translator specialists for any README work.

AI & Automation 1,207 stars 221 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# README 4-File Sync Procedure The GitHub-facing README set is 4 files at the repo root: | File | Locale | Role | |------|--------|------| | `README.ko.md` | ko | **canonical / primary** — author here first | | `README.md` | en | derived | | `README.ja.md` | ja | derived | | `README.zh.md` | zh | derived | > **Chain history**: the canonical locale was English until 2026-08-17, when > card t47 promoted the ko new-skeleton (feature-oriented section structure) > to canonical per the operator decision — aligning the README chain with the > docs-site chain, which was already ko-canonical. The former en-skeleton > redesign reference (`.moai/reports/readme-docs-redesign-20260713.md`) is > superseded by the ko skeleton and kept as history only. ## Procedure 1. **Author** the change in `README.ko.md` (Korean) only. Respect the canonical ko section skeleton; keep the file length in the range of the current set. 2. **Derive** en, ja, zh — same PR, one derived file per translator worker. Translate the changed sections minimally; do not rewrite untouched prose. 3. **Preserve verbatim** across all 4 files: code blocks, command names, badges, version strings, file paths, tables' structure, Mermaid direction, and the switcher header (below). 4. **Verify parity** (checklist below) before returning. ## Language-switcher header contract [HARD] All 4 files share the same switcher header near the top, linking the sibling files with the label set exactly: ``` English · 한국어 ·...

Details

Author
modu-ai
Repository
modu-ai/moai-adk
Created
12 months ago
Last Updated
today
Language
Go
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category