hns-oss-docs-i18n-rules

Enforces hard i18n rules for 4-locale README and Hugo docs-site content.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining a documentation set across four locales (ko, en, ja, zh) often leads to drift: translations diverge from the canonical source, versions get hardcoded inconsistently, and formatting rules like Mermaid direction or emoji usage are applied unevenly. This Skill gives documentation specialists a single digest of the hard i18n rules that must be checked before any edit to the moai-adk README set or the adk.mo.ai.kr docs-site.

Core Features & Use Cases

  • Canonical-locale enforcement: Defines Korean as the canonical source for both the README set and the docs-site, with a strict derivation chain (ko → en → ja/zh) that must land in the same PR.
  • Formatting and content rules: Covers Mermaid TD-only diagrams, the no-emoji icon-shortcode rule, emphasis-marker spacing, the docs-domain URL blacklist, and version single-source-of-truth in hugo.toml.
  • Redirect and deployment constraints: Requires locale-aware vercel.json redirects for moved pages and treats the Vercel production binding as immutable, keeping publishing human-gated.
  • Use Case: Before editing README.ko.md, a specialist loads this Skill, learns that all four locale files must be updated in the same PR, and avoids committing a canonical-only change that would fail the locale-parity gate.

Quick Start

Load the i18n rules digest and list every hard rule I must follow before editing the Korean README and its three derived locales.

Frequently Asked Questions about hns-oss-docs-i18n-rules

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

FAQPage Schema
How do I keep 4-locale documentation in sync across translations?

Author content only in the canonical Korean locale, then derive en, ja, and zh versions in the same pull request. A canonical edit without its three derived counterparts fails the locale-parity check, so never merge partial translations.

What is the canonical locale for the moai-adk README files?

Korean (README.ko.md) is the canonical locale for the README set, following the operator decision recorded as card t47. README.md, README.ja.md, and README.zh.md are derived from it and must never be edited to fix canonical content.

Can I use Mermaid flowchart LR in Hugo documentation?

No. Only top-down directions are allowed: flowchart TD and graph TB. LR and RL directions are forbidden, and translations must preserve the diagram direction verbatim.

How do I add redirects for moved pages on a Vercel Hugo site?

Add two entries to docs-site/vercel.json for every moved page: a locale-aware rule mapping /:locale(ko|en|ja|zh)/old-path to /:locale/new-path, plus a non-locale fallback redirecting /old-path to /ko/new-path.

Where is the version number defined for a Hugo docs site?

The single source of truth is params.version and params.releaseDate in docs-site/hugo.toml. Every release updates both values plus README badges and in-page version examples in the same PR; historical version citations stay untouched.

Why should documentation avoid emoji in body text?

The docs-site uses an icon shortcode ({{<>}}) with variants ok, warn, danger, primary, and muted instead of emoji for consistent rendering. Typographic symbols like arrows and checkmarks, and branding emoji in orchestrator-banner code examples, are preserved.