Skip to content

docs: 현재 프로젝트 구조와 운영 문서 동기화 - #118

Merged
CoBool merged 5 commits into
mainfrom
docs/sync-project-documentation
Sep 5, 2026
Merged

CoBool merged 5 commits into
mainfrom
docs/sync-project-documentation

Conversation

@CoBool

@CoBool CoBool commented Sep 5, 2026

Copy link
Copy Markdown
Owner

변경 내용

  • README / README.ko의 현재 구조를 실제 코드와 맞춤
    • features/pwa 추가
    • src/lib 역할 설명 수정
    • deployment validation 구성 반영
  • pnpm build의 실제 파이프라인 문서화
    • 배포 버전 생성
    • 정적 export
    • build-version.json / versioned sw.js
    • Pagefind 색인 및 export 검증
  • CI 설명에 Playwright browser smoke test와 실패 trace 보관 추가
  • PWA 매니페스트, 서비스 워커, 오프라인 복구, 열린 탭의 배포 버전 감지 동작 추가
  • 환경변수 표를 실제 배포 계약과 맞추고 NEXT_PUBLIC_BUILD_VERSION이 내부 생성 값임을 명시
  • .env.example에 build version을 직접 설정하지 말아야 한다는 안내 추가
  • DEPLOY.md의 기존 운영 문서를 보존하면서 build version / service worker cache 예외를 명확히 보강
  • README 문서 목록에 SECURITY.md 추가

변경 이유

최근 PWA 캐시 수명, 배포 버전 감지, 브라우저 스모크 테스트가 추가되면서 README 계열이 실제 구현보다 한 단계 뒤처져 있었습니다. 코드와 문서가 서로 다른 계약을 설명하지 않도록 현재 production 동작을 기준으로 동기화합니다.

검증

  • 코드 변경 없음, 문서와 설정 예시만 수정
  • main...docs/sync-project-documentation 비교 확인
  • 변경 파일 4개: README.md, README.ko.md, .env.example, DEPLOY.md
  • DEPLOY.md 기존 보안·nginx·검색·복구 문서 보존 확인
  • 최종 diff: README 각 +21/-12, .env.example +3/-1, DEPLOY.md +4/-2

@CoBool
CoBool merged commit 4e9bf86 into main Sep 5, 2026
1 check passed
@CoBool
CoBool deleted the docs/sync-project-documentation branch September 5, 2026 13:21
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