Skip to content

Docs Index

📖 이 docs 는 VitePress 사이트로도 빌드된다 — prose 마크다운(아래 폴더들)은 사이드바·검색과 함께 렌더되고, design/ 카탈로그는 /design 에 verbatim 호스팅. 배포는 operations/docs-site-deploy.md. 로컬: cd docs && npm install && npm run docs:dev.

design/ 은 docs 중 유일하게 빌드되는 정적 사이트(자체 package.json + Vite)다. 나머지 폴더는 생 마크다운.

분류 기준:

폴더무엇빈도
dev/어떻게 빌드하나, 어떤 스타일로 짜나, git 룰매일
platform/특정 OS / 프레임워크의 함정, 디버깅 매뉴얼막혔을 때
operations/외부 시스템 다룰 때 쓰는 정보배포 / 마이그레이션 / 등록 시
policies/왜 이렇게 결정했나정책 변경 / onboarding 시
api/endpoint 별 명세 + 실 curl 예제새 endpoint 만들 때 / AI 가 endpoint 작업 시
spec/화면 / flow / 도메인 룰 (기획자 관점)새 feature 설계 시
design/토큰 SSOT + 컴포넌트/화면 카탈로그 (빌드되는 사이트)UI 작업 시

dev/ — 개발

platform/ — 플랫폼 gotchas

operations/ — 운영

  • infrastructure.md — Railway 환경변수, 미들웨어, Admin API, GraphQL
  • prod-db.md — Railway PostgreSQL 마이그레이션 이력 + 테이블 규모
  • app-store.md — Apple / Google 앱 등록 + IAP 상품
  • cloudflare-deploy.md — frontend CF Workers + Static Assets 배포 (OpenNext for Cloudflare)
  • docs-site-deploy.md — 이 docs 사이트(VitePress + design verbatim) CF Pages 배포 + CF Access

policies/ — 정책 / 의사결정 이력

api/ — API 명세 (점진 작성)

  • README.md — endpoint markdown 템플릿 + curl 예제 룰

spec/ — 화면 / flow / 도메인 + 아키텍처


다른 위치 (docs/ 외)

  • ~/.config/cloud-tokens/README.md — 인프라 토큰 (Railway / Vercel) 사용법
  • CONTRIBUTING.md — 브랜치 / 커밋 / PR 규칙
  • CLAUDE.md (project root) — 프로젝트 절대 룰 + 디렉토리 + 자주 쓰는 명령
  • ~/.claude/CLAUDE.md — 글로벌 작업 룰 (자동 실행, 메모리 저장 룰)