refactor: split CLAUDE.md into focused documentation structure #14

agentson · 2026-02-04T10:08:37+09:00

agentson commented

2026-02-04 10:08:37 +09:00

Summary

CLAUDE.md를 주제별 문서로 분산하여 컨텍스트 크기를 최소화했습니다.

Changes

새로 생성된 문서 (4개)

docs/workflow.md
- Git Workflow Policy
- Agent Workflow (병렬 실행 전략, 특화 에이전트 역할)
- 에이전트 사용 지침
docs/commands.md
- Common Command Failures (tea CLI, Gitea API, Git, Python/Pytest)
- Build & Test Commands
- Environment Setup
docs/architecture.md
- System Overview
- Core Components (Broker, Brain, Risk Manager, Evolution)
- Data Flow Diagram
- Database Schema
- Error Handling
docs/testing.md
- Test Structure (54 tests)
- Coverage Requirements (≥80%)
- Test Configuration
- Writing New Tests
- Running Tests

재작성된 문서

CLAUDE.md (115 lines → 81 lines)

간결한 프로젝트 개요
Quick Start 가이드
다른 문서로의 링크 허브
핵심 원칙 요약
주요 명령어 요약

기타 변경

.gitignore에 data/ 디렉토리 추가 (데이터베이스 파일 제외)

문서 구조

CLAUDE.md (허브) ─┬─ docs/workflow.md (개발 프로세스)
                  ├─ docs/commands.md (명령어 레퍼런스)
                  ├─ docs/architecture.md (시스템 설계)
                  ├─ docs/testing.md (테스트 가이드)
                  └─ docs/agents.md (정책 및 제약사항)

Benefits

✅ 컨텍스트 크기 대폭 감소 (AI 어시스턴트 효율성 향상)
✅ 주제별 빠른 참조 가능
✅ 문서 유지보수성 향상
✅ 필요한 정보만 선택적 로드

Testing

문서 변경사항이므로 별도 테스트 불필요.

References

Closes #13

## Summary CLAUDE.md를 주제별 문서로 분산하여 컨텍스트 크기를 최소화했습니다. ## Changes ### 새로 생성된 문서 (4개) 1. **docs/workflow.md** - Git Workflow Policy - Agent Workflow (병렬 실행 전략, 특화 에이전트 역할) - 에이전트 사용 지침 2. **docs/commands.md** - Common Command Failures (tea CLI, Gitea API, Git, Python/Pytest) - Build & Test Commands - Environment Setup 3. **docs/architecture.md** - System Overview - Core Components (Broker, Brain, Risk Manager, Evolution) - Data Flow Diagram - Database Schema - Error Handling 4. **docs/testing.md** - Test Structure (54 tests) - Coverage Requirements (≥80%) - Test Configuration - Writing New Tests - Running Tests ### 재작성된 문서 **CLAUDE.md** (115 lines → 81 lines) - 간결한 프로젝트 개요 - Quick Start 가이드 - 다른 문서로의 링크 허브 - 핵심 원칙 요약 - 주요 명령어 요약 ### 기타 변경 - .gitignore에 data/ 디렉토리 추가 (데이터베이스 파일 제외) ## 문서 구조 ``` CLAUDE.md (허브) ─┬─ docs/workflow.md (개발 프로세스) ├─ docs/commands.md (명령어 레퍼런스) ├─ docs/architecture.md (시스템 설계) ├─ docs/testing.md (테스트 가이드) └─ docs/agents.md (정책 및 제약사항) ``` ## Benefits - ✅ 컨텍스트 크기 대폭 감소 (AI 어시스턴트 효율성 향상) - ✅ 주제별 빠른 참조 가능 - ✅ 문서 유지보수성 향상 - ✅ 필요한 정보만 선택적 로드 ## Testing 문서 변경사항이므로 별도 테스트 불필요. ## References Closes #13

agentson added 1 commit 2026-02-04 10:08:37 +09:00

refactor: split CLAUDE.md into focused documentation structure

CI / test (pull_request) Has been cancelled

Details

193d54a56c

- Restructure docs into topic-specific files to minimize context
- Create docs/workflow.md (Git + Agent workflow)
- Create docs/commands.md (Common failures + build commands)
- Create docs/architecture.md (System design + data flow)
- Create docs/testing.md (Test structure + guidelines)
- Rewrite CLAUDE.md as concise hub with links to detailed docs
- Update .gitignore to exclude data/ directory

Benefits:
- Reduced context size for AI assistants
- Faster reference lookups
- Better maintainability
- Topic-focused documentation

Closes #13

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

agentson force-pushed feature/issue-13-docs-refactor from 193d54a56c to 05e8986ff5

2026-02-04 10:13:54 +09:00

Compare

jihoson merged commit 2becbddb4a into main

2026-02-04 10:15:09 +09:00

jihoson referenced this issue from a commit

2026-02-04 10:15:10 +09:00

Merge pull request 'refactor: split CLAUDE.md into focused documentation structure' (#14) from feature/issue-13-docs-refactor into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jihoson/The-Ouroboros#14