Agent skill

Hns Oss Docs Readme Sync

by modu-ai in modu-ai/moai-adk

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…

Apache-2.0Auto-check: notesDevelopment

Install Hns Oss Docs Readme Sync

skills CLI
$ npx skills add modu-ai/moai-adk --skill hns-oss-docs-readme-sync -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install modu-ai/moai-adk hns-oss-docs-readme-sync --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/modu-ai/moai-adk.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/hns-oss-docs-readme-sync .claude/skills/hns-oss-docs-readme-sync && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
hns-oss-docs-readme-sync
GitHub stars
1.2k
Token cost
~945 tokens
SKILL.md length
395 words
Files
1
Skills in repo
48
Repo updated
First seen
Licence
Apache-2.0

At a glance

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…

  • Works in 4 steps: Author the change in README.ko.md… → Derive en, ja, zh — same PR, one derived… → Preserve verbatim across all 4 files:… → …
  • Tasks that involve Technical documentation
  • SKILL.md covers Procedure, Language-switcher header…, Section-order parity checklist and Manual verification recipe, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Hns Oss Docs Readme Sync is an agent skill from modu-ai/moai-adk. 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.

Its SKILL.md is about 950 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation, Translation and Linting and formatting. The repository describes itself as: Agentic development harness for Claude Code — SPEC-driven plan/run/sync, TRUST 5 quality gates, model+effort routing, and Claude×GLM multi-LLM cost control. Single Go binary, 16… The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Technical documentation
  • Tasks that involve Translation
  • Tasks that involve Linting and formatting

Example prompts

  • “/hns-oss-docs-readme-sync”

Requirements

  • Pre-approved tools (allowed-tools): Read, Grep, Glob, Bash

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Author the change in README.ko.md (Korean) only. Respect the
  2. Derive en, ja, zh — same PR, one derived file per translator worker.
  3. Preserve verbatim across all 4 files: code blocks, command names,
  4. Verify parity (checklist below) before returning.

What it can do on your machine

Read from SKILL.md and the folder at commit 2aab5f7. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Grep
    • Glob
    • Bash

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Hns Oss Docs Readme Sync loads about 945 tokens when it runs. Until then it costs about 95 tokens; SKILL.md has 395 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~95
When it runs · the whole SKILL.md, loaded when a task matches
~945

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Read, Grep, Glob, Bash

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from modu-ai/moai-adk at commit 2aab5f7, republished under its Apache-2.0 licence (© modu-ai). 395 words, ~945 tokens.

Download SKILL.mdSave it as .claude/skills/hns-oss-docs-readme-sync/SKILL.md (or your agent's skills folder).
name
hns-oss-docs-readme-sync
description
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.
allowed-tools
Read, Grep, Glob, Bash
user-invocable
false
metadata.version
2.0.0
metadata.category
harness
metadata.status
active
metadata.updated
2026-08-17
metadata.tags
oss-docs,readme,4-locale,translation,parity

README 4-File Sync Procedure

The GitHub-facing README set is 4 files at the repo root:

FileLocaleRole
README.ko.mdkocanonical / primary — author here first
README.mdenderived
README.ja.mdjaderived
README.zh.mdzhderived

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 · 한국어 · 日本語 · 中文
  • 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.
Show full SKILL.md (175 more words)Show less

Section-order parity checklist

  • grep -c '^## ' README.md README.ko.md README.ja.md README.zh.md — identical H2 counts across the 4 files.
  • H2 section ORDER matches ko (compare grep '^## ' output order).
  • H3 counts per section match for sections you touched.
  • Table row counts match in touched sections.
  • Code-block count matches (```` grep -c '^```' ```` is even and equal).
  • Switcher header present and correct in all 4.
  • URL blacklist clean: grep -n 'docs\.moai-ai\.dev\|adk\.moai\.com\|adk\.moai\.kr' README*.md → no matches.

Manual verification recipe

No linter exists for the README set — verification is the manual recipe above plus rendering sanity: preview the markdown (GitHub-flavored) for the touched sections and confirm Mermaid blocks declare TD/TB only. The runnable docs-site checks live in Skill("hns-oss-docs-verify"); the README-specific checks are the greps above.

Anti-patterns

Anti-patternCorrect approach
Editing README.md first "because GitHub is English-facing"README canonical is ko — author README.ko.md, then derive
Re-authoring an entire derived file for a 3-line canonical changeMinimal-diff derivation of the changed sections
"Improving" facts/figures during translationReport the discrepancy; amend canonical first
Dropping the switcher header in a redesignThe 4-entry header is a HARD shared contract

© modu-ai, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/hns-oss-docs-readme-sync of modu-ai/moai-adk.

Open the folder on GitHubat commit 2aab5f7

Compare with similar skills

Hns Oss Docs Readme Sync next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Hns Oss Docs Readme Sync compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Hns Oss Docs Readme Sync this skillmodu-ai/moai-adk1.2k—~945Automated safety check: NotesApache-2.0
WooCommerce Markdown Guidelineswoocommerce/woocommerce11k1 repos~1.7kAutomated safety check: PassCustom licence
Moonbit Docs Maintainermoonbitlang/moonbit-docs2.5k—~1.1kAutomated safety check: PassCustom licence
Swig Conventionsswig/swig6.3k—~2.7kAutomated safety check: PassCustom licence
Qwen Agentthananon/9arm-skills3.2k—~1.5kAutomated safety check: PassNone
Translate It Doc En Zhmxsm/rocketmq-rust1.5k—~1.2kAutomated safety check: PassApache-2.0

Similar skills

  • WooCommerce Markdown Guidelines

    woocommerce/woocommerce

    Rules for writing and editing markdown in the WooCommerce repository, with the project's markdownlint settings for headings, lists and code blocks.

    11k GitHub starsUsed in 1 repo~1.7k tokens
    DevelopmentAuto-check passed
  • Moonbit Docs Maintainer

    moonbitlang/moonbit-docs

    A skill your agent uses when maintaining the moonbitlang/moonbit-docs repository, including Sphinx docs under next/, MoonBit examples under next/sources/, error-code documentation, gettext…

    2.5k GitHub stars~1.1k tokensUpdated 18 days ago
    DevelopmentAuto-check passed
  • SWIG source and contribution conventions: clang-format / code formatting, C/C++ comment style (quotes, widths, function header blocks), parser.y new-code rules, alphabetical ordering of makefile…

    6.3k GitHub stars~2.7k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Qwen Agent

    thananon/9arm-skills

    Delegate menial, well-scoped coding tasks to a cheap Qwen-backed subagent via the claude-9arm command instead of burning Claude tokens/quota.

    3.2k GitHub stars~1.5k tokensUpdated 3 mo ago
    DevelopmentAuto-check passed
  • Translate It Doc En Zh

    mxsm/rocketmq-rust

    Translate English IT and software engineering documents into professional, accurate Chinese.

    1.5k GitHub stars~1.2k tokensUpdated today
    DevelopmentAuto-check passed
  • Publish Mod

    rehan-remade/universal-modder

    Package and release a finished game mod. An agent skill from rehan-remade/universal-modder.

    5.8k GitHub stars~812 tokensUpdated today
    DevelopmentAuto-check: notes

More from modu-ai/moai-adk

All 48 skills in this repo
  • Builds hand-editable SVG diagrams from computed layout coordinates, lints the source and renders a 2x PNG, with rules for when mermaid is the better choice.

    1.2k GitHub stars~5.2k tokensUpdated today
    Auto-check: notes
  • MoAI Foundation Core

    modu-ai/moai-adk

    Reference for MoAI-ADK's core development principles: TRUST 5 quality gates, SPEC-first domain-driven workflow, agent delegation and token budgeting.

    1.2k GitHub stars~5k tokensUpdated today
    Auto-check passed
  • MoAI SPEC Workflow

    modu-ai/moai-adk

    Manages SPEC documents for MoAI-ADK development, with GEARS or EARS requirement notation, acceptance criteria and a link into the Plan-Run-Sync workflow.

    1.2k GitHub stars~5.1k tokensUpdated today
    Auto-check passed
  • MoAI TDD Workflow

    modu-ai/moai-adk

    Drives test-first development through the RED, GREEN, REFACTOR cycle, with a config switch that selects between TDD and a DDD workflow for existing code.

    1.2k GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • MoAI Worktree Management

    modu-ai/moai-adk

    Gives each SPEC its own Git worktree with a registry of active workspaces, base-branch sync and cleanup of merged ones, inside the MoAI-ADK workflow.

    1.2k GitHub stars~3.9k tokensUpdated today
    Auto-check passed
  • Watches a pull request's CI checks after creation, separates required from auxiliary failures, applies limited safe fixes and escalates anything semantic to you.

    1.2k GitHub stars~2.4k tokensUpdated today
    Auto-check: notes

Categories

Questions about Hns Oss Docs Readme Sync

What does Hns Oss Docs Readme Sync do?

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…. Hns Oss Docs Readme Sync is an agent skill from modu-ai/moai-adk.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).

When should I use Hns Oss Docs Readme Sync?

Hns Oss Docs Readme Sync fits situations like: tasks that involve Technical documentation; tasks that involve Translation; tasks that involve Linting and formatting.

How do I install Hns Oss Docs Readme Sync in Claude Code?

Run `npx skills add modu-ai/moai-adk --skill hns-oss-docs-readme-sync -a claude-code`. Or copy the skill folder (.claude/skills/hns-oss-docs-readme-sync in modu-ai/moai-adk) into .claude/skills/hns-oss-docs-readme-sync in your project. Claude Code loads it when a task matches its description.

How do I install Hns Oss Docs Readme Sync in Codex?

Run `npx skills add modu-ai/moai-adk --skill hns-oss-docs-readme-sync -a codex`. Or copy the skill folder (.claude/skills/hns-oss-docs-readme-sync in modu-ai/moai-adk) into .agents/skills/hns-oss-docs-readme-sync in your project. Codex loads it when a task matches its description.

Can I use Hns Oss Docs Readme Sync in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add modu-ai/moai-adk --skill hns-oss-docs-readme-sync -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/hns-oss-docs-readme-sync, .gemini/skills/hns-oss-docs-readme-sync, .github/skills/hns-oss-docs-readme-sync and .opencode/skills/hns-oss-docs-readme-sync in your project.

What does Hns Oss Docs Readme Sync need to run?

SKILL.md names no scripts, command-line tools or credentials: Hns Oss Docs Readme Sync is instructions for the agent only. Its frontmatter pre-approves these tools: Read, Grep, Glob, Bash.

Does Hns Oss Docs Readme Sync access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Hns Oss Docs Readme Sync safe to install?

Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Hns Oss Docs Readme Sync use?

Hns Oss Docs Readme Sync is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Hns Oss Docs Readme Sync use?

About 945 tokens (SKILL.md is roughly 3.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Hns Oss Docs Readme Sync?

Skills that share tags, products or a category with Hns Oss Docs Readme Sync: WooCommerce Markdown Guidelines (woocommerce/woocommerce, 11k stars), Moonbit Docs Maintainer (moonbitlang/moonbit-docs, 2.5k stars), Swig Conventions (swig/swig, 6.3k stars) and Qwen Agent (thananon/9arm-skills, 3.2k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Hns Oss Docs Readme Sync?

modu-ai (a GitHub organization) maintains it in modu-ai/moai-adk, which has 1,232 GitHub stars. The repository holds 48 skills in this directory. The repository was last updated on October 9, 2026.

Source: modu-ai/moai-adk on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.