Skip to content

Commit eaccc10

Browse files
committed
docs: refactor documentation — slim README + guide/ directory with 8 detailed docs
1 parent 6352296 commit eaccc10

10 files changed

Lines changed: 630 additions & 326 deletions

File tree

.claude/CLAUDE.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ Graceful shutdown: SIGINT/SIGTERM 시 진행 중인 clone/build에 context cance
4141

4242
`.ccg.yaml`로 exclude 패턴, DB 설정 등을 프로젝트 기본값으로 관리할 수 있습니다.
4343

44-
## 어노테이션 시스템
45-
46-
코드에 다음 태그를 사용하여 AI/비즈니스 컨텍스트를 기록합니다:
47-
- `@index` — 파일/패키지 수준 설명
48-
- `@intent` — 함수의 목적/의도
49-
- `@domainRule`비즈니스 규칙
50-
- `@sideEffect`부작용
51-
- `@mutates`변경 대상
52-
- `@requires` / `@ensures` — 사전/사후 조건
53-
- `@param`, `@return`, `@see` — 표준 태그
44+
## 문서
45+
46+
상세 문서는 `guide/` 디렉토리를 참조하세요:
47+
- [CLI Reference](guide/cli-reference.md) — 전체 명령어, 플래그, 설정 파일
48+
- [MCP Tools](guide/mcp-tools.md) — 28개 MCP 도구, Skills, AI-Driven Annotation
49+
- [Annotations](guide/annotations.md)어노테이션 태그, 예시, 검색
50+
- [Webhook](guide/webhook.md)Webhook sync, 브랜치 필터링, HMAC, graceful shutdown
51+
- [Docker](guide/docker.md)Docker 빌드, MCP 서버, PostgreSQL 배포
52+
- [Development](guide/development.md) — 개발 가이드, Integration test, 프로젝트 구조
53+
- [Architecture](guide/architecture.md) — 데이터 흐름, 컴포넌트, DB 스키마
5454

5555
## 개발 규칙
5656

0 commit comments

Comments
 (0)