Skip to content

docs: 저장소 첫 화면과 문서 탐색 구조 정리#53

Open
hywznn wants to merge 1 commit into
mainfrom
agent/readme-navigation
Open

docs: 저장소 첫 화면과 문서 탐색 구조 정리#53
hywznn wants to merge 1 commit into
mainfrom
agent/readme-navigation

Conversation

@hywznn

@hywznn hywznn commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

왜 필요한가요?

기존 README는 상세 정보가 한 파일에 416줄로 모여 있어 저장소 첫 화면에서
Swagger, DB ERD, 실행 방법과 개발 규칙을 찾기 어려웠습니다. API 개수처럼
변경 때마다 쉽게 낡는 정보도 첫 화면에 포함돼 있었습니다.

무엇이 바뀌나요?

  • README 첫 화면에 CI·문서 상태와 핵심 목적을 배치했습니다.
  • Swagger, OpenAPI JSON, DB 문서, 개발 가이드, 프로젝트 구조, ADR, AI 계약,
    Roadmap, Wiki 링크를 상단 표로 모았습니다.
  • 고정 API 개수를 제거하고 실제 구현 판단 기준을 Swagger와 테스트로
    명확히 했습니다.
  • README를 416줄에서 197줄로 줄였습니다.
  • 인증·Task·승인·Profile·Demo Seed 상세 설명은
    docs/development-guide.md로 분리했습니다.
  • 패키지 책임·의존 방향·Flyway·테스트 규칙은
    docs/project-structure.md로 분리했습니다.
  • 저장소 경계와 개인정보·승인 보안 원칙은 첫 화면에 유지했습니다.

사용자·개발자 영향

  • 처음 참여한 사람은 README 상단에서 필요한 문서로 바로 이동할 수 있습니다.
  • 실제 API와 DB 구조는 자동 생성 문서에서 확인하므로 설명이 덜 낡습니다.
  • 코드, API, DB와 환경 설정은 변경하지 않는 문서 전용 PR입니다.

검증

  • git diff --check
  • README와 신규 문서의 모든 로컬 Markdown 링크 존재 여부 확인
  • Swagger·OpenAPI·Database Pages 정상 주소 반영
  • README 197줄, 개발 가이드 209줄, 프로젝트 구조 173줄로 역할 분리

참고

main 직접 반영을 시도했지만 Branch Protection이 PR과
Test and build를 필수로 요구해 이 PR로 전환했습니다.

@hywznn
hywznn requested review from chaeliki and krestar July 24, 2026 17:08
@hywznn hywznn added area:server Spring Boot API·도메인·DB·tenant·Task Workflow 영역; Prompt·모델·Provider 구현 제외 priority:P2 일정에 따라 미룰 수 있는 보완 작업 status:in-review 구현을 마치고 리뷰 또는 병합을 기다리는 작업 type:docs README·Wiki·API 설명 등 문서 작업 labels Jul 24, 2026
@hywznn
hywznn marked this pull request as ready for review July 24, 2026 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:server Spring Boot API·도메인·DB·tenant·Task Workflow 영역; Prompt·모델·Provider 구현 제외 priority:P2 일정에 따라 미룰 수 있는 보완 작업 status:in-review 구현을 마치고 리뷰 또는 병합을 기다리는 작업 type:docs README·Wiki·API 설명 등 문서 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant