메뉴
Enforce documentation updates when modifying sync logic. Triggers on changes to src/internal/sync/ or sync model types. Must update docs/architecture.md, docs/sync-protocol.md, website/src/architecture/sync-protocol.md, and website/src/usage/sync.md.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | sync-docs |
| description | Enforce documentation updates when modifying sync logic. Triggers on changes to src/internal/sync/ or sync model types. Must update docs/architecture.md, docs/sync-protocol.md, website/src/architecture/sync-protocol.md, and website/src/usage/sync.md. |
| license | MIT |
| allowed-tools | Read |
When modifying any file under src/internal/sync/ or src/internal/model/types.go,
you MUST check and update the following documentation files:
| Change Type | Files to Update |
|---|---|
| Protocol (push/pull/handshake) | docs/sync-protocol.md, website/src/architecture/sync-protocol.md |
| Architecture (flow, modules, watcher) | docs/architecture.md |
| User behavior (CLI, config) | website/src/usage/sync.md |
| Data model (FileRecord fields) | docs/sync-protocol.md, docs/architecture.md |
Before marking a sync task complete:
docs/architecture.md reflects new/changed sync behaviordocs/sync-protocol.md reflects new/changed protocol detailswebsite/src/architecture/sync-protocol.md mirrors the protocol docswebsite/src/usage/sync.md reflects user-facing behavior changes