diff --git a/CLAUDE.md b/CLAUDE.md index 9387fa9..f3c1177 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -87,6 +87,7 @@ Smart Scanner runs in both `TRADE_MODE=realtime` and `daily` paths. On API failu ## Documentation +- **[Documentation Hub](docs/README.md)** — Top-level doc routing and reading order - **[Workflow Guide](docs/workflow.md)** — Git workflow policy and agent-based development - **[Command Reference](docs/commands.md)** — Common failures, build commands, troubleshooting - **[Architecture](docs/architecture.md)** — System design, components, data flow diff --git a/README.md b/README.md index 587ac0c..2fade9f 100644 --- a/README.md +++ b/README.md @@ -217,6 +217,7 @@ The-Ouroboros/ ## 문서 +- **[문서 허브](docs/README.md)** — 전체 문서 라우팅, 우선순위, 읽기 순서 - **[아키텍처](docs/architecture.md)** — 시스템 설계, 컴포넌트, 데이터 흐름 - **[테스트](docs/testing.md)** — 테스트 구조, 커버리지, 작성 가이드 - **[명령어](docs/commands.md)** — CLI, Dashboard, Telegram 명령어 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..f50a6b9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,48 @@ +# Documentation Hub + +이 문서는 저장소 전체 문서의 상위 라우팅 허브입니다. +세부 문서로 바로 들어가기 전에 아래 우선순위와 읽기 순서를 기준으로 이동하세요. + +## Priority (SSOT) + +1. 실행/협업 규칙 SSOT: [workflow.md](./workflow.md) +2. 명령/장애 대응 SSOT: [commands.md](./commands.md) +3. 테스트/검증 SSOT: [testing.md](./testing.md) +4. 에이전트 제약 SSOT: [agents.md](./agents.md) +5. 요구사항 추적 SSOT: [requirements-log.md](./requirements-log.md) +6. Ouroboros 실행 문서 허브: [ouroboros/README.md](./ouroboros/README.md) + +## Recommended Reading Order + +1. [workflow.md](./workflow.md) +2. [commands.md](./commands.md) +3. [testing.md](./testing.md) +4. [agents.md](./agents.md) +5. [architecture.md](./architecture.md) +6. [context-tree.md](./context-tree.md) +7. [disaster_recovery.md](./disaster_recovery.md) +8. [live-trading-checklist.md](./live-trading-checklist.md) +9. [ouroboros/README.md](./ouroboros/README.md) + +## Document Map + +- Core + - [workflow.md](./workflow.md): 브랜치/PR/리뷰/세션 handover 정책 + - [commands.md](./commands.md): 실행 커맨드, 실패 사례, 트러블슈팅 + - [testing.md](./testing.md): 테스트 구조, 작성 규칙, 검증 명령 + - [agents.md](./agents.md): 에이전트 작업 제약과 금지 행위 + - [agent-constraints.md](./agent-constraints.md): 영속 제약/운영 불변식(agents.md 보완) + - [skills.md](./skills.md): 설치/사용 가능한 스킬 목록과 활용 가이드 +- Design and Operations + - [architecture.md](./architecture.md): 시스템 구조와 컴포넌트 책임 + - [context-tree.md](./context-tree.md): L1-L7 컨텍스트 계층 설계 + - [disaster_recovery.md](./disaster_recovery.md): 백업/복구 절차 + - [live-trading-checklist.md](./live-trading-checklist.md): 실전 전환 체크리스트 +- Governance and Planning + - [requirements-log.md](./requirements-log.md): 요구사항/피드백 히스토리 + - [ouroboros/README.md](./ouroboros/README.md): v2/v3 실행 문서 라우팅 + +## Change Rule + +- 문서 신규/이동/대규모 개편 시 이 파일의 링크와 분류를 함께 갱신합니다. +- 링크는 상대경로만 사용합니다.