docs: Expand README with API and architecture details

[dahyun24]

Added detailed sections for API documentation, ERD, system architecture, technology stack, CI/CD, and monitoring.

🚀 변경 유형

• ✨ 기능 추가 (feature)
• 🐛 버그 수정 (fix)
• 📝 문서 변경 (docs)
• ♻️ 리팩토링 (refactor)
• 🧪 테스트 추가 / 수정 (test)
• ⚙️ 설정 변경 (chore)

📝 작업 내용

• 리드미 작업

💬 리뷰 요구사항

📜 리뷰 규칙

Reviewer는 아래 P5 Rule을 참고하여 리뷰를 진행합니다.
P5 Rule을 통해 Reviewer는 Reviewee에게 리뷰의 의도를 보다 정확히 전달할 수 있습니다.

• P1: 꼭 반영해주세요 (Comment)
• P2: 적극적으로 고려해주세요 (Comment)
• P3: 웬만하면 반영해 주세요 (Comment)
• P4: 반영해도 좋고 넘어가도 좋습니다 (Approve)
• P5: 그냥 사소한 의견입니다 (Approve)

Summary by CodeRabbit

• 문서 (Documentation)
  • 리포지토리 제목을 대체한 종합 README: 서비스 소개, 링크 및 썸네일 추가
  • Backend 멤버 및 팀 정보 섹션 추가
  • API 명세 링크(스웨거) 추가 및 ERD 이미지 포함
  • 시스템 아키텍처 다이어그램 및 폴더 구조 다이어그램 추가
  • 기술 스택 상세화(버전 포함) 및 배포/모니터링/로깅 설명 보강
  • 커밋 컨벤션 표(커밋 타입 의미) 추가

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README.md에서 기존 단일 리포지토리 제목을 제거하고 공용 서비스 설명, 팀 구성, Swagger API 명세 링크, ERD·시스템 아키텍처 이미지 및 기술 스택(언어/프레임워크, DB/캐시, CI/CD/배포, 모니터링/로깅)과 커밋 컨벤션을 포함한 문서 전반을 대체·확장했습니다. (50단어 이내)

Changes

Cohort / File(s)	Change Summary
Documentation Expansion README.md	리포지토리 제목 제거 및 공용 서비스 소개 추가. Backend 멤버 및 팀 정보 추가. Swagger API 명세(링크/섬네일) 추가. ERD 이미지 및 시스템 아키텍처 이미지 섹션 추가. 기술 스택을 언어/프레임워크, 데이터베이스/캐시, CI/CD/배포, 모니터링/로깅으로 재구성 및 상세화. 폴더 구조 다이어그램 및 커밋 컨벤션 표 추가. 기존 리포지토 타이틀을 사용자 중심 문서로 대체.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• 문서 변경만 포함되어 코드 로직 검토는 불필요합니다.
• 검토 시 유의사항:
  • README 내 외부 링크(Swagger, 이미지 등) 유효성 확인
  • ERD/아키텍처 이미지 경로 및 접근권한 검증
  • CI/CD/배포 및 모니터링/로깅 설명이 실제 환경과 일치하는지 확인

Poem

🐰 README 들판에 새벽빛 비치네,
API 길잡이 반짝이며 이끌고,
ERD 잎새마다 관계가 춤추며,
배포 구름 위로 서비스가 뛰어오르고,
토끼는 박수, 문서는 환히 웃네 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	PR 제목은 주요 변경 사항(README 확장)을 명확하게 설명하며, API와 아키텍처 세부사항 추가를 정확히 반영합니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dahyun24-patch-1

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6807003 and 58e262a.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

10-10: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

10-10: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

70-70: No space after hash on atx style heading

(MD018, no-missing-space-atx)

🔇 Additional comments (1)

README.md (1)

1-69: 포괄적인 README 문서화 작업이 우수합니다.

API 명세서, ERD, 시스템 아키텍처, 기술 스택, 폴더 구조, 커밋 컨벤션 등을 체계적으로 정리하여 프로젝트의 기술적 맥락을 명확히 제시하셨습니다.

과거 피드백(서비스 링크 마크다운 형식, 테이블 공백, 이미지 alt 텍스트)의 대부분을 반영하셨으며, 새로 추가된 섹션들의 이미지 alt 텍스트도 설명적으로 작성되었습니다.

위의 두 가지 마크다운 스타일 이슈(Line 10의 alt 속성, Line 70의 헤딩 공백)만 해결하면 완벽합니다.

Also applies to: 71-83

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

6-10: GitHub 자산 이미지 URL의 장기 안정성 확인

ERD와 시스템 아키텍처 이미지가 GitHub asset URL로 호스팅되고 있습니다. 이 URL들이 저장소에서 제거되거나 이동할 경우 손상될 수 있으니, 이미지를 프로젝트 디렉토리(예: docs/images/)에 저장하고 상대 경로로 참조하는 것을 권장합니다.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bbbf86a and ae2287a.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (2)

README.md (2)

3-4: Swagger API 명세서 링크 접근성 확인 필요

개발 환경의 Swagger 링크(https://dev.say-cheese.me/swagger-ui/index.html#/)가 공개적으로 접근 가능한지, 또는 인증이 필요한지 확인하시기 바랍니다. 필요시 프로덕션 환경 링크로 업데이트하거나 접근 제한을 문서화하는 것을 권장합니다.

---

12-32: 기술 스택 섹션 구성 - 탁월한 구조와 설명

기술 스택이 명확한 카테고리별로 잘 정리되어 있으며, 각 도구의 목적을 설명하는 한글 주석이 이해도를 높입니다. 특히 CI/CD 자동화 흐름과 모니터링 스택의 세부 설명이 새로운 팀원이나 기여자에게 유용할 것 같습니다.

다만 다음 항목들의 정확성을 확인하시기 바랍니다:

• Blue-Green 배포가 실제 운영 환경에 구현되어 있는지 확인
• 모니터링 스택(Promtail, Loki, Grafana, Prometheus)이 모두 현재 활성 운영 중인지 확인
• 버전 정보(Spring Boot 3.5.6, Java 21)가 현재 프로젝트에서 사용 중인 정확한 버전인지 확인

[zyovn]

짱~~

[coderabbitai]

Actionable comments posted: 5

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ae2287a and 6807003.

⛔ Files ignored due to path filters (1)

• img.png is excluded by !**/*.png

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

2-2: Bare URL used

(MD034, no-bare-urls)

---

7-7: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

---

9-9: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

9-9: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

69-69: No space after hash on atx style heading

(MD018, no-missing-space-atx)

🔇 Additional comments (1)

README.md (1)

12-42: 문서화 확장이 우수합니다.

API 명세서, ERD, 시스템 아키텍처, 기술 스택, CI/CD, 모니터링/로깅 섹션이 잘 정리되어 있습니다. 팀원들이 프로젝트 전체 구조와 운영 방식을 명확히 이해할 수 있도록 구성되었습니다. Blue-Green 배포, 중앙 집중형 로깅, 모니터링 전략이 구체적으로 설명되어 있어 좋습니다.