Skip to content

docs: README를 AtchaV2 기준으로 전면 재작성하고 모듈 아키텍처 다이어그램 추가 - #376

Merged
YuGeonHui merged 2 commits into
env/devfrom
docs/v2-readme-architecture
Sep 25, 2026
Merged

YuGeonHui merged 2 commits into
env/devfrom
docs/v2-readme-architecture

Conversation

@YuGeonHui

@YuGeonHui YuGeonHui commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

문제

README가 1.x 레거시 기준에 머물러 있었다. 레포의 실제 개발은 Tuist 기반 AtchaV2로 옮겨갔는데 README는 여전히 단일 타겟 구조, Swift 5 / iOS 14, 이미 V2에 없는 기능(택시비 계산, TMap 길찾기)과 라이브러리(Alamofire, Combine)를 설명하고 있었다. 새로 온 사람이 README만 보고는 어디서 무엇을 빌드해야 하는지 알 수 없었다.

변경

  • 모듈 아키텍처 다이어그램 — Archify로 생성. 12개 모듈과 의존 관계를 각 Project.swift의 의존성 선언을 근거로 그렸다(커밋 3dbd748 기준, 참조 12개 검증 통과). README에는 라이트/다크 PNG를 <picture>로 넣어 보는 사람의 테마를 따른다.
  • 인터랙티브 버전 — docs/architecture/atcha-v2-modules.html(내려받아 열면 노드 검색·경로 추적·가이드 뷰 3개). 원본 스펙 atcha-v2-modules.architecture.json을 함께 두어 모듈이 바뀌면 스펙만 고쳐 다시 생성할 수 있다.
  • README 전면 재작성(V2 전용) — 소개, 주요 기능, 의존 규칙, 모듈 표, 피처 컨벤션, 기술 스택, 시작하기(mise PATH 함정 포함), 디렉터리 구조를 V2 기준으로. 1.x 홍보 이미지·택시비 태그라인·레거시 섹션은 제거(레거시 작업 규칙은 CLAUDE.md에 그대로 있다).
  • 스토어 링크와 팀 섹션은 유지.

검증

  • Archify deliver: 9/9 체크, showcase 구성 오류 0 · 경고 0 (선 교차·노드 관통 0)
  • Archify visual-check: 1440×900 ~ 2048×1320 뷰포트에서 넘침 없음
  • README 이미지 두 장 육안 확인

참고

  • atcha-v2-modules.html은 약 800KB(뷰어 런타임 내장). README 이미지는 PNG라 이 파일 없이도 동작한다.
  • V2 화면 스크린샷은 docs/verification에 128px 썸네일만 있어 README에 넣지 않았다.

🤖 Generated with Claude Code

YuGeonHui and others added 2 commits September 25, 2026 00:50
- Archify로 생성한 모듈 아키텍처 다이어그램(라이트/다크 PNG)을 README에 삽입
- 인터랙티브 HTML과 원본 스펙(각 Project.swift 근거, 커밋 3dbd748 기준)을 docs/architecture에 추가
- 기능·기술 스택·시작하기·디렉터리 구조를 V2 기준으로 갱신, 레거시 1.x 안내 분리

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- 1.x 홍보 이미지·택시비 태그라인 제거, 소개 문구를 막차 알람 중심으로 재작성
- 레거시 섹션과 디렉터리 트리의 레거시 항목 제거

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@YuGeonHui YuGeonHui changed the title docs: README를 AtchaV2 기준으로 재작성하고 모듈 아키텍처 다이어그램 추가 docs: README를 AtchaV2 기준으로 전면 재작성하고 모듈 아키텍처 다이어그램 추가 Sep 24, 2026
@YuGeonHui
YuGeonHui merged commit 81bbca7 into env/dev Sep 25, 2026
1 check passed
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