Skip to content

Claude 설정 문서의 낡은 서술 정리 - #95

Merged
m-a-king merged 2 commits into
mainfrom
docs/claude-md-stale-cleanup
Oct 3, 2026
Merged

m-a-king merged 2 commits into
mainfrom
docs/claude-md-stale-cleanup

Conversation

@m-a-king

@m-a-king m-a-king commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Situation

설정 문서 감사 결과

  • CLAUDE.md 가 protobuf 계약 파일럿 이후 구성을 반영하지 않음
  • 공개 표기 기준이 09-28 완화 이전 문구로 남음
  • 테스트 사전 조건·stub 이름·소비자 서술이 코드와 다름

Task

낡은 서술 정리

  • 낡은 서술은 삭제
  • 지우면 정보가 사라지는 자리는 현재 사실로 교체

Action

현재 사실로 교체

대상 이전 이후
계약 정본 extraction-api.md·에러 카탈로그 둘 infra contracts/, 파일별 역할은 docs/api-contract.md, 모양 변경은 proto 먼저
docs/api-contract.md proto 역할 와이어 모양 모양과 필드 의미
docs/api-contract.md 컨버터 ContractMessageConverterConfig ProtobufJsonConverterConfig
공개 표기 기준 "헤드리스로 라우팅" 수준까지만 renderer 이름·역할·호출 관계와 Chrome·JS 스택 표기까지
소비자 core 워커 하나뿐 core 하나(파싱 작업 워커·관리자 모델 프로브)
예외 정책의 클라이언트 core 워커 core
테스트 사전 조건 ./gradlew test 가 그냥 돎 shared-infra/contracts/ 필요, 없으면 계약 클래스가 생성되지 않아 컴파일 실패
stub 목록 S3 ImageStorage
core 버전 맞춤 jsoup·guava·AWS SDK·springdoc 나열 core build.gradle.kts 에도 있는 라이브러리
크기 상한 상수 셋 나열과 이력 포인터 PruningHtmlParser.MAX_RETAINED_CHARS Javadoc 포인터

삭제

종류 대상
반복 로깅 절의 LoggerFactory 금지 불릿 (언어 절 @Slf4j 규칙과 같음)
일반론 SLF4J placeholder 불릿

Result

범위

  • 범위: 로깅 레벨의 SSRF 차단 서술은 보류
    • 원인: 문서는 warn, InternalHostGuard 는 error. 문서와 코드 중 어느 쪽을 맞출지 결정 대기
  • 후속: ModelProbeRequest.java 주석이 포인터 문서가 된 docs/api-contract.md §2 를 계약 위치로 가리킴. 코드 주석이라 이 PR 밖

연관 이슈

- 계약 정본 목록에 extraction.proto 추가
  - 원인: 요청·응답 모양의 정본이 proto 로 옮겨 감. 빌드가 shared-infra/contracts/ 에서 클래스를 생성
- 모양 변경 시 infra proto 선행 수정 규칙 추가
- 공개 표기 기준을 renderer 이름·역할·호출 관계와 스택 표기까지로 갱신
  - 원인: 옛 기준 문구가 현행 기준과 어긋남
- 소비자 서술을 core 하나(파싱 작업 워커·관리자 모델 프로브)로 갱신
  - 원인: 관리자 모델 프로브도 /internal/models/probe 호출
- 테스트 사전 조건에 shared-infra/contracts/ 명시
  - 원인: 계약 파일이 없으면 proto 생성 단계에서 컴파일 실패
- core 공유 라인 목록을 core build.gradle.kts 기준 규칙으로 교체
  - 원인: 목록에 없는 라이브러리 포함·protobuf 누락
- 크기 상한 상수 나열·이력 서술을 Javadoc 포인터 한 줄로 교체
  - 원인: 상수 목록이 코드 복제라 낡음
- 통합 stub 목록의 S3 를 ImageStorage 로 교체
- 로깅 절의 중복 불릿 2개 삭제
  - 원인: LoggerFactory 금지는 Lombok 절과 중복·placeholder 규칙은 자명
- docs/api-contract.md 의 컨버터 클래스명을 ProtobufJsonConverterConfig 로 교체
  - 원인: 옛 클래스명 ContractMessageConverterConfig 가 코드에 없음
@m-a-king m-a-king added the docs 문서만 만지는 작업 label Sep 29, 2026
@m-a-king m-a-king self-assigned this Sep 29, 2026
@github-actions

Copy link
Copy Markdown

Discord 스레드 연동용 메타데이터입니다. discord-pr-bot 워크플로가 자동 생성하며, 수정·삭제하면 PR 과 Discord 알림 연동이 끊깁니다.

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: e3a8480e-50dd-4991-903d-f542fb906817

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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.

- CLAUDE.md 계약 정본 문장을 docs/api-contract.md 포인터로 축약
  - 원인: 필드 의미의 정본은 extraction.proto 주석. 새 문장이 api.md 로 보내 정본과 어긋남
- api-contract.md 의 proto 역할에 필드 의미 추가
- 테스트 사전 조건의 실패 지점을 컴파일 단계로 교체
  - 원인: srcDir 가 비면 generateProto 는 빈 결과로 통과함
- protobuf 버전 맞춤 문장 삭제
  - 원인: repo 안 protoc·runtime 은 한 변수로 묶임. repo 간 와이어는 JSON 이라 버전 차이 영향 없음
@m-a-king
m-a-king merged commit 645892b into main Oct 3, 2026
4 checks passed
@m-a-king
m-a-king deleted the docs/claude-md-stale-cleanup branch October 3, 2026 13:59
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