What problem does it solve?
Documentation sites with multiple locales and strict style rules accumulate silent drift: broken Hugo builds, missing translated pages, stale version badges, blacklisted URLs, and inconsistent section counts. This Skill provides a runnable exit gate that verifies all of these dimensions before any docs change is accepted.
Core Features & Use Cases
- Build and sitemap verification: Runs a warning-free
hugo --minify --gc build and confirms sitemap.xml exists.
- Content and style gates: Greps for blacklisted domains, forbidden Mermaid LR/RL diagram directions, and body-text emoji that should use icon shortcodes.
- 4-locale parity ratchet: Checks file-existence parity across ko/en/ja/zh pages and compares per-page section counts against a checked-in baseline, failing only on newly divergent pages.
- Version-sync check: Ensures README badges and example version strings match the release version declared in
hugo.toml.
- Use Case: Before merging a docs update that touches Korean and English pages, run this gate to confirm the build is clean, no page lost locale parity, and all version displays match the current release.
Quick Start
Run the oss-docs verify gate on the docs-site directory and report any failing checks before handing results back to the orchestrator.
