Skip to content

Update README.md#125

Closed
DGAZA-max wants to merge 1 commit into
developfrom
DGAZA-max-patch-1
Closed

Update README.md#125
DGAZA-max wants to merge 1 commit into
developfrom
DGAZA-max-patch-1

Conversation

@DGAZA-max
Copy link
Copy Markdown
Contributor

@DGAZA-max DGAZA-max commented Apr 28, 2026

캐싱 결과 사진 추가

캐싱 결과 사진 출가
@github-actions
Copy link
Copy Markdown

🤖 AI 코드리뷰

리더보드 — 현재 4위 (리뷰 106건) | 전체 8개 팀 참여 중
업데이트 확인 — 리뷰가 질문을 던지다 — 생각해보기

📋 과제 요구사항 준수 여부

  • 검색 API v1, v2 공존 및 비교 문서화: README 내 v1 vs v2 비교 섹션에 시각화 자료(이미지)를 추가하여 두 API의 차이점을 직관적으로 보여주려는 의도는 확인됨.

🟡 개선 제안

외부 호스팅 이미지 참조의 위험성

  • GitHub Issues/PR에 업로드된 이미지(user-attachments/assets)는 해당 저장소가 Private으로 전환되거나, 이슈/PR이 삭제될 경우 404 Broken Image가 됩니다. README.md는 프로젝트의 얼굴이자 지속적으로 유지되어야 하는 문서입니다.
  • 해결책: 해당 이미지 파일을 프로젝트 루트의 docs/images/ 등 리포지토리 내부 디렉토리에 직접 커밋하여 상대 경로(![image](./docs/images/api-comparison.png))로 참조하세요. 문서의 영속성은 선택이 아니라 필수입니다.

💡 학습 포인트

  • 정적 리소스 관리: 마크다운 문서에 이미지를 삽입할 때 외부 링크를 그대로 가져오는 것은 운영 환경(예: Wiki, README 등)에서 종종 빈 화면을 유발하는 흔한 실수입니다. CI/CD 파이프라인이나 오픈소스 관리 측면에서 에셋은 코드와 함께 버전 관리하는 것이 원칙입니다.

🤔 생각해보기

💬 이 질문에 대해 궁금한 점이 있으면 코멘트에 @sparta 를 남겨보세요!
"만약 이 저장소가 사내망으로 이관되어 외부 인터넷(GitHub raw content) 접근이 차단된 폐쇄망 환경에서 빌드 및 문서화 파이프라인이 돌아간다면, 지금의 이미지 참조 방식은 어떤 연쇄적인 문제를 유발할까요?"


AI 리뷰는 참고용입니다. 최종 판단은 팀원이 직접 합니다.

@DGAZA-max DGAZA-max closed this Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants