Skip to content

docs: v2 API 기준 한국어 문서 및 튜토리얼 정비#217

Merged
seyoung4503 merged 10 commits intomasterfrom
docs/tutorial-restructure
Mar 15, 2026
Merged

docs: v2 API 기준 한국어 문서 및 튜토리얼 정비#217
seyoung4503 merged 10 commits intomasterfrom
docs/tutorial-restructure

Conversation

@seyoung4503
Copy link
Collaborator

Summary

  • 한국어 개념 문서(Core_concept, BaseComponent, BaseFlow, Hook_and_exception)를 v2 API 규약에 맞게 업데이트
  • RunContext 중심 설명을 타입 인자 패턴으로 교체, SequentialFlow → 프리셋 Flow 반영
  • 튜토리얼 02에 Factory 함수 섹션 추가 (build_llm_from_env 등)
  • 튜토리얼 05에 DataHub 카탈로그 로더 및 Port 프로토콜 레퍼런스 테이블 추가
  • 레거시 quickstart.md 삭제 (튜토리얼 01~05 시리즈로 대체)

Test plan

  • 문서 내 코드 예시가 현재 v2 API와 일치하는지 확인
  • 튜토리얼 01~05 간 "다음 단계" 링크 정상 동작 확인
  • 마크다운 렌더링 확인

🤖 Generated with Claude Code

seyoung4503 and others added 10 commits March 2, 2026 21:09
  Delete v2-complete-tutorial.md, v2-usage-guide.md, vector-retriever.md,
  vector-store-backends.md, getting-started-without-datahub.md.
  Content redistributed into 01-05 series.
  Restructure docs/tutorials/ into a progression:
    01-quickstart    — BaselineNL2SQL 5분 실행
    02-baseline      — DB Explorer, CSV 카탈로그, CLI 사용법
    03-vector-search — FAISS/pgvector 인덱싱, save/load
    04-hybrid        — HybridNL2SQL, EnrichedNL2SQL, QuestionGate
    05-advanced      — 수동 조합, 커스텀 어댑터, MemoryHook, 트러블슈팅

  All examples use real OpenAI API. CLI options documented in 02-baseline.
튜토리얼 시리즈(01~05)로 대체되어 더 이상 사용되지 않는 파일 삭제

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- RunContext 기반 예시를 KeywordRetriever/SQLGenerator 실제 API로 교체
- "상태는 RunContext 하나로" 섹션 제거, 명시적 타입 인자 패턴으로 대체
- 스마트 따옴표를 일반 따옴표로 통일

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- "철학: Define-by-run + Minimal core" 중복 섹션 삭제
- 스마트 따옴표를 일반 따옴표로 통일
- LangGraph 등 특정 프레임워크 언급 제거

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- run() → _run() 메서드 규약 반영
- SequentialFlow 중심 설명을 프리셋 Flow(BaselineNL2SQL 등)로 교체
- MemoryHook API를 hook.snapshot()으로 업데이트
- closure/partial 패턴 섹션 제거

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- RunContext 반환 계약 예시를 _run() 반환 타입 기반으로 변경

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- build_llm_from_env, build_embedding_from_env, build_db_from_env 사용법 추가
- 지원 프로바이더 테이블 및 .env 예시(Anthropic + PostgreSQL) 포함
- 파이프라인 연동 예시 추가

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- DataHubCatalogLoader 사용법 및 파이프라인 연동 예시 추가
- 전체 Port 프로토콜 레퍼런스 테이블 추가 (10개 Port, 시그니처 포함)
- 기존 섹션 번호 재정렬 (5→7 Hook, 6→8 Best Practices, 7→9 트러블슈팅)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@seyoung4503 seyoung4503 merged commit 286b1b7 into master Mar 15, 2026
2 checks passed
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