hns-oss-docs-verify

Featured

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.

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 Verify Recipe (exit gate) Runnable checks for the sprint-contract dimensions. **The scripts `docs-i18n-check.sh` and `gen_menu.py` DO NOT exist — never shell out to them; every check is inlined below.** All checks are read-only; this skill never commits or pushes. ## 1. Build clean (`build-clean`, must_pass, threshold 1.0) ```bash cd docs-site && hugo --minify --gc ``` - Must exit 0 AND complete **warning-free** (any `WARN`/`ERROR` line = FAIL). ```bash test -f docs-site/public/sitemap.xml && echo "sitemap OK" || echo "sitemap MISSING" ``` ## 2. URL blacklist (`content-fidelity`) ```bash grep -rn 'docs\.moai-ai\.dev\|adk\.moai\.com\|adk\.moai\.kr' docs-site/content README*.md ``` - Expected: **no matches**. Only `adk.mo.ai.kr` is valid. Note: the pattern `adk\.moai\.kr` does not match `adk.mo.ai.kr` (different dot positions) — no false positive on the valid domain. ## 3. Mermaid direction (`style-compliance`) ```bash grep -rn 'flowchart LR\|graph LR\|flowchart RL\|graph RL' docs-site/content ``` - Expected: **no matches** (TD-only rule; `flowchart TD` / `graph TB` pass). ## 4. 4-locale parity (`locale-parity`, must_pass, threshold 1.0) File-existence parity — every ko page has en/ja/zh counterparts: ```bash cd docs-site/content && for f in $(cd ko && find . -name '*.md'); do for loc in en ja zh; do [ -f "$loc/$f" ] || echo "MISSING: $loc/$f" done done ``` Section-count parity per locale tree (compare totals): ```bash for loc in ko en ja ...

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
Code & Development Featured

hns-oss-docs-readme-sync

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.

1,143 Updated today
modu-ai
Data & Documents Listed

docs-check

Validate the GitHub Pages documentation site built by @docmd/core. Covers build verification, orphan detection, ADR index freshness, cross-reference integrity, and LLM output audit. Use when editing docs, after merging doc changes, before deploying, or when troubleshooting a broken site build. Do NOT use for content quality review (use markdown-authoring) or agent skill documentation review (use skill-quality-auditor). Triggers: 'check docs', 'build docs', 'verify site', 'docs audit', 'orphan detection', 'docmd check', 'preview docs', 'LLM output check', 'ADR index check', 'documentation validation'.

2 Updated 4 days ago
pantheon-org