Skip to content

README 를 core 시스템 지도 참조로 슬림화 - #25

Merged
m-a-king merged 1 commit into
mainfrom
docs/readme-slim
Aug 10, 2026
Merged

README 를 core 시스템 지도 참조로 슬림화#25
m-a-king merged 1 commit into
mainfrom
docs/readme-slim

Conversation

@m-a-king

@m-a-king m-a-king commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator

Situation

  • README 정리에서 시스템 구성의 정본을 core README 로 정했다 (나머지 repo 는 core 를 참조). 이 README 는 실행법·운영 절차까지 담아 정본과 역할이 겹치고, 일부 서술(outbox 워커, 고정 모델명, 스택 버전 숫자)은 이미 낡아 있었다

Task

  • README 를 역할·API 계약·스택만 남기고 core 시스템 지도를 참조하는 형태로 슬림화한다

Action

  • 실행 섹션과 운영(prod 박스) 섹션을 삭제. 운영 상세의 정본은 deploy.yml 과 infra 의 contracts 이고, public repo 에서 SSM 경로 등 내부 좌표 노출도 함께 사라진다
  • 낡은 서술 정정: 폐기된 outbox 표기 제거(소비자는 core 뿐), 고정 모델명 제거(모델은 런타임에 지정), 스택 버전 숫자 제거(버전의 SSOT 는 빌드 파일)
  • 전체 시스템 구성은 core README 를 참조하는 한 줄 추가

Result

  • README 에 이 repo 고유 정보(API 계약 링크·스택)만 남아, 시스템 서술이 낡을 자리가 줄었다

연관 이슈

Summary by CodeRabbit

  • 문서
    • 서비스 설명을 핵심 기능을 소비하는 내부 서비스로 명확히 정리했습니다.
    • 관련 저장소, 실행·운영·배포·관측·시크릿 안내를 제거해 문서를 간소화했습니다.
    • 핵심 기능 링크와 API 계약 및 기술 스택 정보를 간결하게 개편했습니다.
    • 더 이상 사용되지 않는 Java 25 및 Spring Boot 4 표기를 삭제했습니다.

- 시스템 구성 정본을 core README 로 옮기고 이 README 는 역할·API 계약·스택만 남김
- 실행·운영 섹션 삭제. 운영 상세의 정본은 deploy.yml 과 infra 의 contracts 이고, public repo 라 SSM 경로 등 내부 좌표 노출도 함께 제거
- 폐기된 outbox 표기를 제거하고 LLM 모델명·스택 버전 숫자를 지워 문서 부패 지점을 줄임
@m-a-king m-a-king added the docs 문서만 만지는 작업 label Aug 9, 2026
@m-a-king m-a-king self-assigned this Aug 9, 2026
@coderabbitai

coderabbitai Bot commented Aug 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b7c6a0c-4536-496b-9e2a-812bbd355d25

📥 Commits

Reviewing files that changed from the base of the PR and between 27c6318 and d989bad.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README가 서비스 역할을 core 소비자로 수정합니다. 저장소, 실행, 운영, 배포, 관측, 시크릿 안내를 제거합니다. core 링크와 API 계약 링크를 추가하고 Java 25와 Spring Boot 4 표기를 삭제합니다.

Changes

README 서비스 설명 갱신

Layer / File(s) Summary
서비스 설명 및 안내 갱신
README.md
서비스 설명을 core만 소비하는 내부 서비스로 변경합니다. 운영 관련 안내를 제거하고 core 및 API 계약 링크를 추가합니다. Java 25와 Spring Boot 4 표기를 삭제합니다.

Estimated code review effort: 1 (매우 낮음) | ~2분

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed README를 core 시스템 지도를 참조하도록 슬림화한 주요 변경 내용을 명확하게 요약합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

Comment @coderabbitai help to get the list of available commands.

@m-a-king
m-a-king merged commit f64be1b into main Aug 10, 2026
2 checks passed
@m-a-king
m-a-king deleted the docs/readme-slim branch August 10, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서만 만지는 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant