Skip to content

AI/RAG 아키텍처와 근거 흐름 문서화 - #526

Merged
donghyuck merged 1 commit into
3.xfrom
codex/3x-ai-rag-docs
Jul 27, 2026
Merged

donghyuck merged 1 commit into
3.xfrom
codex/3x-ai-rag-docs

Conversation

@donghyuck

Copy link
Copy Markdown
Owner

Why

  • 루트 README의 AI/RAG 안내가 모듈 이름을 나열하는 수준이라 처음 접하는 개발자가 색인과 근거 기반 답변의 전체 흐름을 이해하기 어려웠습니다.
  • AI/RAG 계약, 문서 metadata, chunking, embedding, citation, SSE와 운영 cache의 책임 경계를 한곳에서 탐색할 수 있는 문서 진입점이 필요했습니다.

What

  • 루트 README.md에 AI/RAG 개요, 전체 흐름 SVG, 구성요소별 담당 모듈 표를 추가했습니다.
  • docs/ai-rag/에 아키텍처, 색인, 근거 기반 Chat, 운영 및 문제 해결 문서를 추가했습니다.
  • 누락돼 있던 studio-platform-document-metadata와 studio-platform-chunking-runtime README를 추가했습니다.
  • AI starter, AI web starter, 모델 카탈로그, Markdown, chunking, embedding pipeline 문서에서 공통 AI/RAG 가이드로 이동할 수 있도록 링크를 정리했습니다.
  • 실제 코드의 PackedEvidenceSet, citation validation, metadata enrichment, backfill 및 SSE canonical 응답 계약과 문서 표현을 대조했습니다.
  • CHANGELOG.md에 문서 개선 내역을 기록했습니다.

Related Issues

  • 별도 Issue 없음: 사용자의 AI/RAG 문서 개선 직접 요청에 따라 진행했습니다.

Validation

  • Command: ./gradlew :studio-platform-document-metadata:test :studio-platform-chunking-runtime:test :studio-platform-markdown:test --no-daemon
  • Result: BUILD SUCCESSFUL
  • Command: ./gradlew :starter:studio-platform-starter-ai-web:test --tests studio.one.platform.ai.web.controller.RagCitationValidatorTest --no-daemon
  • Result: BUILD SUCCESSFUL
  • Command: xmllint --noout docs/ai-rag/images/ai-rag-overview.svg
  • Result: 통과
  • Command: Markdown 내부 링크 검사
  • Result: 15개 파일, 57개 내부 링크 통과
  • Command: git diff --cached --check
  • Result: 통과

Risk / Rollback

  • Risk: 문서의 모듈 책임이나 설정 설명이 이후 구현 변경과 불일치할 수 있습니다. 런타임 동작 변경은 없습니다.
  • Rollback: 이 PR의 단일 문서 커밋을 revert하면 기존 문서 상태로 복원됩니다.

AI / Subagent Usage

  • AI-assisted: Yes
  • Subagent used: No
  • Delegated scope: N/A
  • Main author validation: 실제 Java 계약, README, 설정과 API 경로를 대조하고 관련 테스트 및 링크 검사를 수행했습니다.

Checklist

  • commit message follows policy
  • issue template used or exception recorded
  • AI-Assisted value is correct
  • validation recorded
  • subagent usage recorded when used
  • CI / repository verification passed
  • human review completed before merge
  • no unrelated changes included

Issue:
- 별도 Issue 없음: 사용자의 AI/RAG 문서 개선 직접 요청에 따라 진행

Why:
- 루트 README의 AI/RAG 설명이 한 줄 수준이라 모듈 경계와 색인·근거 답변 흐름을 이해하기 어려웠음

What:
- 루트 README에 AI/RAG 개요, 전체 흐름 SVG, 구성요소 표와 상세 문서 링크를 추가
- 색인, 근거 기반 Chat, 운영 및 문제 해결 가이드를 추가
- document-metadata와 chunking-runtime README를 보완하고 관련 모듈 문서 탐색 경로를 통일

Validation:
- ./gradlew :studio-platform-document-metadata:test :studio-platform-chunking-runtime:test :studio-platform-markdown:test --no-daemon (BUILD SUCCESSFUL)
- ./gradlew :starter:studio-platform-starter-ai-web:test --tests studio.one.platform.ai.web.controller.RagCitationValidatorTest --no-daemon (BUILD SUCCESSFUL)
- xmllint --noout docs/ai-rag/images/ai-rag-overview.svg (통과)
- Markdown 내부 링크 검사: 15 files, 57 links (통과)
- git diff --cached --check (통과)
@donghyuck
donghyuck marked this pull request as ready for review July 27, 2026 01:58
@donghyuck
donghyuck merged commit dfe26d7 into 3.x Jul 27, 2026
2 checks passed
@donghyuck
donghyuck deleted the codex/3x-ai-rag-docs branch July 27, 2026 01:59
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.

1 participant