| description | Use when modifying markdown files, preparing PRs, or suspecting link/structure inconsistencies in documentation. |
| name | doc-lint |
| trigger | ๋ฌธ์ ์ ํฉ์ฑ ๊ฒ์ฌ, ๊นจ์ง ๋งํฌ, INDEX ๋๊ธฐํ, ์นด์ดํธ ๋ถ์ผ์น, ๊ณ ์ ํ์ผ, pre-commit, ๋ฌธ์ ๊ตฌ์กฐ ๊ฒ์ฌ, ์ค๋ณต ํ์ผ, ๊ฒฝ๋ก ์ฐธ์กฐ ๊ฒ์ฆ, ๋ด์ฉ ๊ฒ์ฆ, ์๋ฏธ๋ก ์ ๊ฒ์ฌ, doc-lint, doc lint, markdown check, broken link, orphan file, duplicate file, link check, index sync, count mismatch, ref check, structural check, content validation, ๋ฌธ์ ๊ฒ์ฌ, markdown ์ ํฉ์ฑ |
Quick Reference
- ์คํจ ์ ์ฐ์ ์์: REF-01 โ COUNT-01 โ LINK-01 ์์๋ก ์์
- ๋ณํ ๊ฒ์ฆ: Agent A(CLAUDE/AGENTS), B(README/ARCH), C(INDEX) ๋์ ์คํ
- ๋ถ์ผ์น ์ฒ๋ฆฌ: [MISMATCH] ๋ฐ๊ฒฌ ์ ์ต์ ์์ ํ ์ฆ์ ์ฌ๊ฒ์ฆ
- ์์ ์์น: ๋ณธ๋ฌธ ๋ด์ฉ๊ณผ ์ค์ ํ๋ก์ ํธ ์ํ ์ผ์น ์ฌ๋ถ๋ง ๊ฒ์ฆ
- ์ต์ข
ํ์ธ: ๋ชจ๋ ์์ ์๋ฃ ํ
doc-lint.sh ์ฌ์คํ์ผ๋ก PASS ํ์ธ
Workflow
Step 1: Structural Check
bash .hxsk/scripts/doc-lint.sh
If all PASS, skip to Step 3. If any FAIL, proceed to Step 2.
Step 2: Fix Structural Issues
Fix FAIL items in priority order:
- REF-01 (L1 path references) โ highest impact, affects onboarding
- COUNT-01 (README counts) โ user-facing, most visible
- LINK-01 (broken links) โ navigation broken
- INDEX-01 (INDEX sync) โ discoverability
- ORPHAN-01 (unreferenced files) โ cleanup
- DUP-01 (duplicate names) โ ambiguity
Re-run doc-lint.sh after fixes to confirm PASS.
Step 3: Content Validation (Parallel Agents)
Dispatch 3 parallel agents for semantic checks:
Agent A: CLAUDE.md + AGENTS.md
Read CLAUDE.md and AGENTS.md. Compare every claim (hook events,
workflow descriptions, file paths, agent boundaries) against
actual project state. Report as [MISMATCH] or [OK].
Agent B: README.md + ARCHITECTURE.md
Read README.md and .hxsk/ARCHITECTURE.md. Verify feature lists,
component descriptions, directory structure diagrams against
actual state. Report as [MISMATCH] or [OK].
Agent C: INDEX files (skills, agents, research)
Read each INDEX.md. Verify listed items match actual files,
descriptions are accurate, and no items are missing.
Report as [MISMATCH] or [OK].
Step 4: Apply Content Fixes
Collect agent results. For each [MISMATCH]:
- Read the source file
- Propose minimal fix
- Apply with Edit tool
- Re-run structural check to confirm no regression
Rules Reference
| Rule | What it checks | Scope |
|---|
| LINK-01 | Relative link targets exist | All .md |
| INDEX-01 | INDEX.md lists vs actual files | skills/, agents/, research/ |
| COUNT-01 | README count numbers vs actual | README.md |
| REF-01 | Backtick path references in L1 docs | CLAUDE.md, AGENTS.md |
| ORPHAN-01 | Files not referenced anywhere | All .md (excl. memories, templates) |
| DUP-01 | Same filename in multiple locations | All .md (excl. symlinks) |
Iron Laws
NO CONTENT VALIDATION WITHOUT STRUCTURAL PASS FIRST
NO FIX APPLICATION WITHOUT PRIORITY ORDER ADHERENCE
NO COMPLETION WITHOUT RE-RUN LINT CHECK
NO EDIT WITHOUT MINIMAL FIX PROPOSAL
NO INDEX UPDATE WITHOUT FILE EXISTENCE VERIFICATION