hns-oss-docs-readme-sync

Featured

README 4-file synchronization procedure for the oss-docs harness: English README.md as primary source, ko/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.

Code & Development 1,143 stars 211 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, ~1100 lines each: | File | Locale | Role | |------|--------|------| | `README.md` | en | **canonical / primary** — author here first | | `README.ko.md` | ko | derived | | `README.ja.md` | ja | derived | | `README.zh.md` | zh | derived | SSOT design reference for redesign work: `.moai/reports/readme-docs-redesign-20260713.md` (README full redesign draft + docs-site 12→11 section restructure + 6 new docs × 4 locales). ## Procedure 1. **Author** the change in `README.md` (English) only. Respect the section design from the SSOT report; keep the ~1100-line budget in mind. 2. **Derive** ko, 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 · 한국어 · 日本語 · 中文 ``` - The current file's own label renders as plain text; the other 3 are links to the sibling README files. - Never reorder, drop, or re-label the 4 entries. ## Section-order parity checklist - [ ] `grep -c '^## ' README.md README.ko.md RE...

Details

Author
modu-ai
Repository
modu-ai/moai-adk
Created
10 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

AI & Automation Featured

hns-oss-docs-i18n-rules

HARD i18n rules digest for the oss-docs harness specialists working on moai-adk-go README 4-locale set and the docs-site (adk.mo.ai.kr). Covers the canonical-locale chains, the 4-locale same-PR obligation, Mermaid TD-only, the no-emoji + icon-shortcode rule, emphasis-marker spacing, the URL blacklist, version SSOT, vercel.json redirect pattern, and the immutable Vercel binding. Loaded FIRST by every oss-docs specialist before any edit.

1,143 Updated today
modu-ai
AI & Automation Featured

hns-oss-docs-verify

Mandatory verify recipe for the oss-docs harness — the runnable exit gate every specialist executes before returning: warning-free hugo build, sitemap existence, URL-blacklist grep, Mermaid LR/RL direction grep, 4-locale file-existence and section-count parity, README 4-file heading parity, and body-emoji scan. All checks are inlined here because docs-i18n-check.sh and gen_menu.py do not exist.

1,143 Updated today
modu-ai
Code & Development Featured

hns-oss-docs-structure-map

docs-site structure map for the oss-docs harness structure-curator: exact paths and schemas for hugo.toml, per-locale content/<locale>/_meta.yaml, data/menu/main.yaml (4-locale name maps + icon values), the icon-to-SVG-case coupling in layouts/partials/menu.html, shortcodes, the FROZEN moai-brand.css, vercel.json redirect examples, and the known design-vs-guides divergence. Loaded by the structure-curator before any navigation or config edit.

1,143 Updated today
modu-ai