Check Docs Consistency

Check Docs Consistency

SEED Design System의 문서 레이어 간 일관성을 검증합니다.

Quick Start

1. 단일 컴포넌트 점검인지 전체 감사인지 범위를 먼저 결정합니다.
2. Rootage/Design Docs/React Docs 3개 레이어를 동일한 컴포넌트 ID로 비교합니다.
3. 불일치 유형(이름/설명/props/파일 누락)을 분류해서 보고합니다.
4. 세부 규칙은 details/validation-rules.md, 실행 절차는 details/workflow.md를 참고합니다.

문서 레이어

검증 항목

1. Naming Consistency

rootage.metadata.name === designDocs.title === reactDocs.title

2. Description Consistency

designDocs.description === reactDocs.description

3. Props Coverage

extractedPropsFromYAML ⊆ documentedPropsInDesignDocs

4. Component ID Match

<PlatformStatusTable componentId="X" /> where X === rootage.metadata.id
<ComponentSpecBlock id="X" /> where X === rootage.metadata.id

5. File Existence

if (rootageYAML.exists()) {
  designDocs.shouldExist()
  reactDocs.shouldExist()
}

Quick Reference

Full Audit

# 모든 Rootage YAML 검색
ls packages/rootage/components/*.yaml

# 각 컴포넌트에 대해 문서 존재 확인
# 내용 비교 및 불일치 보고

Single Component Check

# 특정 컴포넌트만 검증
# packages/rootage/components/{id}.yaml
# docs/content/docs/components/{id}.mdx
# docs/content/react/components/{id}.mdx

Output Format

Compact

✅ action-button - Fully consistent
⚠️  checkbox - Warning: Description differs
❌ badge - Critical: Missing Props table
📋 divider - Missing: Design guidelines not found

Detailed

## action-button
Status: ✅ Fully consistent

Checks:
- ✅ Name consistency (Action Button)
- ✅ Description matches
- ✅ Props documented (6/6)
- ✅ Component IDs correct
- ✅ All files exist

상세 가이드

각 검증 규칙의 상세 내용은 details/ 폴더 참조:

• details/validation-rules.md - 검증 규칙 상세
• details/workflow.md - 검증 워크플로우

사용 시나리오

Converted and distributed by TomeVault — claim your Tome and manage your conversions.