docs: 저장소 첫 화면과 문서 탐색 구조 정리#53
Open
hywznn wants to merge 1 commit into
Open
Conversation
hywznn
marked this pull request as ready for review
July 24, 2026 17:11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
왜 필요한가요?
기존 README는 상세 정보가 한 파일에 416줄로 모여 있어 저장소 첫 화면에서
Swagger, DB ERD, 실행 방법과 개발 규칙을 찾기 어려웠습니다. API 개수처럼
변경 때마다 쉽게 낡는 정보도 첫 화면에 포함돼 있었습니다.
무엇이 바뀌나요?
Roadmap, Wiki 링크를 상단 표로 모았습니다.
명확히 했습니다.
docs/development-guide.md로 분리했습니다.docs/project-structure.md로 분리했습니다.사용자·개발자 영향
검증
git diff --check참고
main직접 반영을 시도했지만 Branch Protection이 PR과Test and build를 필수로 요구해 이 PR로 전환했습니다.