Skip to content

docs: 기여자용 ARCHITECTURE.md — 한눈 가이드#231

Closed
seyoung4503 wants to merge 1 commit into
masterfrom
docs/architecture-guide
Closed

docs: 기여자용 ARCHITECTURE.md — 한눈 가이드#231
seyoung4503 wants to merge 1 commit into
masterfrom
docs/architecture-guide

Conversation

@seyoung4503
Copy link
Copy Markdown
Collaborator

무엇

신규 컨트리뷰터가 10분 안에 파악할 수 있도록 만든 단일 문서 `docs/ARCHITECTURE.md`.

v4.1 rebuild로 코드가 크게 바뀌어서, 기존 컨트리뷰터/신규 컨트리뷰터 모두 어디 무엇이 있고 어디를 손대면 좋은지 한 곳에서 보고 싶음. redesign 문서는 길어서 부담스러움.

포함

  1. 한 눈 아키텍처 — ASCII 다이어그램(frontends → tenancy → harness → 4기둥 → adapters)
  2. 왜 이 구조 — 4기둥(★① safety / ★② memory / ★③ ingestion / ★④ federation) 매핑
  3. 디렉토리·레이어 가이드 — 각 디렉토리 책임 + 파일 경로 링크 30+개
  4. 한 메시지의 lifecycle — Discord 멘션이 들어와서 답이 나가기까지 9단계 추적
  5. Extension Points — 새 LLM / 새 DB / 새 safety layer / 새 recall / 새 ingestion source / 새 frontend / 새 도구 추가하는 정확한 위치 + 방법
  6. 빠른 기여 시작 — 5분 안에 환경 구축 + pytest 통과
  7. 코드 컨벤션 — Protocol, lazy engine, to_thread, frontend 격리 등 7개 약속

추가 변경

  • `README.md`의 "🤝 기여하기" 섹션 맨 위에 `ARCHITECTURE.md` 링크 추가.

🤖 Generated with Claude Code

처음 보는 사람도 10분 안에 "어디 무엇이 있고 / 어디를 손대면 좋은지"
파악할 수 있는 단일 문서.

내용:
- 한 눈에 보는 아키텍처 (ASCII 다이어그램)
- 왜 이 구조인가 — 4기둥 매핑
- 디렉토리·레이어 가이드 (파일 경로 링크 다수)
- 한 메시지의 lifecycle (Discord 멘션 따라가기)
- Extension points — 새 LLM/DB/safety layer/recall/frontend/도구 추가법
- 빠른 기여 시작 + 코드 컨벤션

README의 "기여하기" 섹션에서 ARCHITECTURE.md를 가장 먼저 보도록 안내.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@seyoung4503
Copy link
Copy Markdown
Collaborator Author

이 PR의 변경은 #232 정리 PR에 흡수되어 함께 머지됩니다. (cleanup PR이 SSOT + ARCHITECTURE 둘 다 포함)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant