Docs/#91 documentation

[kkshyun]

📍 PR 타입 (하나 이상 선택)

• 기능 추가
• 버그 수정
• 의존성, 환경 변수, 빌드 관련 코드 업데이트
• 기타 사소한 수정

❗️ 관련 이슈 링크

Close #91

📌 개요

• 문서 작업

🔁 변경 사항

• AI-Architecture-Crawling-to-AI-Jobs.md 수정
• Metrics-Monitoring.md 작성
• README.md 수정

📸 스크린샷

👀 기타 더 이야기해볼 점

✅ 체크 리스트

• PR 템플릿에 맞추어 작성했어요.
• 변경 내용에 대한 테스트를 진행했어요.
• 프로그램이 정상적으로 동작해요.
• PR에 적절한 라벨을 선택했어요.
• 불필요한 코드는 삭제했어요.

Summary by CodeRabbit

릴리스 노트

• Documentation
  • 프로젝트 개요, 기술 스택, 핵심 기능, 시스템 아키텍처를 포함한 포괄적인 README 문서를 작성했습니다.
  • AI 크롤링에서 작업 처리까지의 전체 파이프라인 아키텍처 문서를 추가했습니다.
  • 메트릭 수집 및 모니터링 구성 가이드 문서를 새로 작성했습니다.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

프로젝트 문서 구조를 전면 재정리하며 README, AI 아키텍처, 메트릭 모니터링 문서를 신규 작성했습니다. 기술 스택, 핵심 기능, 시스템 아키텍처, ERD 등을 포괄적으로 정리하고 공개 인터페이스 경계를 명확히 했습니다.

Changes

Cohort / File(s)	요약
README 전체 개편 README.md	초기 Git Flow 가이드를 완전히 대체하여 프로젝트 개요, 기술 스택(Backend/DB/AI/Monitoring), 핵심 기능(CI/CD, 인증, 푸시 알림, 모니터링, 크롤링, AI 비동기 작업), 시스템 아키텍처 다이어그램, ERD, 트러블슈팅, 팀원 소개 섹션을 추가. Git 컨벤션도 구체적 예제와 함께 확장됨.
AI 아키텍처 문서 재작성 docs/AI-Architecture-Crawling-to-AI-Jobs.md	기존 계층적 구조에서 튜토리얼 형식의 단계별 크롤링-AI 작업 파이프라인 설명으로 전환. 공개 표면으로 NaverEconomyCrawlScheduler, AiJobService, AiJobWorker, AiJobSweeper 등 14개 엔티티/서비스 신규 지정, 2개(AiJobRepository, AiAdminController) 제거. 구체적 코드 샘플과 시퀀스 다이어그램 추가로 이해도 향상.
메트릭 모니터링 신규 문서 docs/Metrics-Monitoring.md	Spring Boot Actuator, Micrometer, 커스텀 메트릭 구현, Promtail 로그 수집, Grafana Cloud 대시보드 구성, Discord 알림 통합을 다루는 종합 가이드 신규 추가. application.yaml, prometheus.yml, docker-compose.yml 등 실제 설정 예제와 대시보드 쿼리 포함.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

이유: 순수 문서 변경으로 로직이나 런타임 동작에 영향이 없습니다. 다만 공개 API 경계(public entities) 14개 신규 지정 및 2개 제거로 문서-코드 일치도를 확인할 필요는 있습니다. 변경이 주로 구조화와 설명 확충이므로 복잡도는 낮습니다.

Possibly related PRs

• 📝 docs: Git Flow 및 커밋 메시지 가이드 README 추가 #11: README.md 수정으로 Git Flow 및 커밋 메시지 가이드를 추가/변경한 PR과 겹침. 같은 문서에 대한 연쇄 작업 가능성.
• Refactor/#24 optimization #26: 크롤러 서브시스템 변경(NaverEconomyCrawlScheduler에 ConditionalOnProperty 추가, application.yaml 토글 수정)을 다루며, 이 PR에서 공개 표면으로 지정한 같은 컴포넌트와 직접 연관됨.

---

📋 검수 시 확인 포인트

칭찬할 부분:

• ✨ 공개 API 경계를 명확히 문서화하여 외부 사용자가 쉽게 통합할 수 있도록 한 점이 좋습니다.
• ✨ 크롤링-AI 작업 파이프라인을 시퀀스 다이어그램으로 시각화하여 이해도를 크게 높였습니다.

확인 권장사항:

• 📌 공개 엔티티 14개 신규 지정: 실제 코드에서 이들이 정말 public 클래스/enum으로 선언되어 있는지, 아니면 문서만 먼저 작성된 건 아닌지 확인하세요.
• 📌 AiJobRepository, AiAdminController 제거: 이들이 더 이상 공개 인터페이스가 아닌 이유가 명확한지, 의존하는 코드가 없는지 확인하세요.
• 📌 Docker Compose 설정: Metrics-Monitoring.md의 docker-compose 예제가 현재 운영 환경과 일치하는지 점검하세요.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/#91-documentation

---

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.}