hns-oss-docs-i18n-rules

Featured

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.

AI & Automation 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

# oss-docs HARD i18n Rules SSOT: `.moai/docs/docs-site-i18n-rules.md` (+ CLAUDE.local.md §17.1 for the design/icon regime). This skill is the working digest; on conflict, the SSOT wins — EXCEPT the two stale items in § Known-Stale below, where reality wins. ## 1. Canonical-locale chains [HARD] | Surface | Canonical | Derivation chain | Derived files | |---------|-----------|------------------|---------------| | docs-site | **ko** | ko → en → ja/zh, same PR | `docs-site/content/{en,ja,zh}/` | | README | **en** (`README.md`) | en → ko/ja/zh, same PR | `README.ko.md`, `README.ja.md`, `README.zh.md` | - Author in the canonical locale only; derive the rest. Never "fix" canonical content inside a translation — report the discrepancy back instead. ## 2. 4-locale simultaneous-update obligation [HARD] Every canonical content change MUST land in all 4 locales in the same PR. A canonical edit without its 3 derived counterparts is a locale-parity FAIL (sprint contract `locale-parity` threshold 1.0, must_pass). ## 3. Mermaid TD-only [HARD] - Allowed: `flowchart TD`, `graph TB`. - Forbidden: `LR` / `RL` directions (`flowchart LR`, `graph LR`, `flowchart RL`, `graph RL`). - Translation preserves diagram direction verbatim. ## 4. No emoji in body text [HARD] - Use the icon shortcode instead: `{{</* icon <name> [variant] */>}}` (defined in `docs-site/layouts/shortcodes/icon.html`; variants: `ok|warn|danger|primary|muted`). - Preserved (NOT emoji — do not strip): typographic ...

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