altair823-org/kebab
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 45 Wiki Activity

docs: README/ARCHITECTURE v0.32.0 동기화 + CLAUDE.md README 최신성 규칙 #224

Merged
altair823 merged 1 commits from docs/sync-readme-architecture-v0-32-0 into main 2026-06-27 11:35:09 +00:00
Conversation 1 Commits 1 Files Changed 4 +17 -16
altair823 commented 2026-06-27 11:31:57 +00:00
Owner
Copy Link

요약

README·ARCHITECTURE 를 최신 코드베이스(v0.32.0)에 맞춰 동기화하고, CLAUDE.md 에 README 최신성을 hard requirement 로 명문화한다. README 는 사용자 설명서 수준, 아키텍처는 ARCHITECTURE.md 라는 altitude 경계도 명시.

변경

README (사용자 설명서 수준 유지)

  • 버전 스탬프 v0.21.0 → v0.32.0 (2곳).
  • 파생물 캐시 설명에 OCR/caption 캐싱 반영 (재색인 시 비싼 vision 호출도 skip — v0.31.0 #217).

ARCHITECTURE (구조 상세)

  • migrations V001..V014 → V015 (drop chat_sessions, v0.31.0).
  • derivation_cache kind: "embedding 만 남음" → embedding + ocr + caption (#217).
  • 9개 code_*_ast_v1.rs → 단일 code_ast_v1.rs / CodeAstV1Chunker (v0.32.0 #220) — dir tree + 결정표.
  • MCP 도구 4 → 8 (schema/doctor/search/bulk_search/ask/fetch/ingest_file/ingest_stdin) — README 와 일치화.
  • stale /build/dogfood 경로 정정.

CLAUDE.md

  • "README 최신성 hard requirement" — 기능 추가/변경/삭제·사용자 표면 변경 시 그 PR 에서 README 동기화(제거 surface 는 README 에서도 제거). 깊이는 사용자 설명서 수준, 아키텍처는 ARCHITECTURE.md.
  • stale TUI bullet 정정 (kebab tui 는 v0.31.0 제거 → CLI 가 유일 UI surface).

code: derivation.rs 모듈 주석 kind 목록 {embedding,alias,korean_tokens} → {embedding,ocr,caption} (source-of-truth 정정).

검증

  • 독립 doc-accuracy 감사: config 기본값 5종(llm gemma4:e4b / embedding multilingual-e5-large 1024d / rag rag-v4 / chunker md-heading-v2 / OCR ollama-vision)·CLI Cmd enum 전 표면·crate 20개·migration V015·derivation kind 를 코드와 전수 대조 → 본 PR 의 2건(MCP 목록·derivation 주석) 외 잔여 staleness 0. 5종 기본값은 kebab-config 의 assertion 테스트로 가드됨.
  • cargo build -p kebab-core (derivation 주석 변경) 컴파일 클린.

비범위

  • 코드 동작 변경 없음 (문서 + 주석 1줄 + 프로젝트 지침).

시험 항목 (Test Plan)

  • kebab --version 과 README 버전 일치(v0.32.0).
  • README 명령 표 ↔ kebab --help 일치.

Assisted-by: Claude Code

## 요약 README·ARCHITECTURE 를 최신 코드베이스(v0.32.0)에 맞춰 동기화하고, CLAUDE.md 에 **README 최신성을 hard requirement** 로 명문화한다. README 는 사용자 설명서 수준, 아키텍처는 ARCHITECTURE.md 라는 altitude 경계도 명시. ## 변경 **README (사용자 설명서 수준 유지)** - 버전 스탬프 `v0.21.0 → v0.32.0` (2곳). - 파생물 캐시 설명에 OCR/caption 캐싱 반영 (재색인 시 비싼 vision 호출도 skip — v0.31.0 #217). **ARCHITECTURE (구조 상세)** - migrations `V001..V014 → V015` (drop chat_sessions, v0.31.0). - `derivation_cache` kind: "embedding 만 남음" → `embedding` + `ocr` + `caption` (#217). - 9개 `code_*_ast_v1.rs` → 단일 `code_ast_v1.rs` / `CodeAstV1Chunker` (v0.32.0 #220) — dir tree + 결정표. - MCP 도구 4 → 8 (`schema`/`doctor`/`search`/`bulk_search`/`ask`/`fetch`/`ingest_file`/`ingest_stdin`) — README 와 일치화. - stale `/build/dogfood` 경로 정정. **CLAUDE.md** - "README 최신성 hard requirement" — 기능 추가/변경/삭제·사용자 표면 변경 시 그 PR 에서 README 동기화(제거 surface 는 README 에서도 제거). 깊이는 사용자 설명서 수준, 아키텍처는 ARCHITECTURE.md. - stale TUI bullet 정정 (`kebab tui` 는 v0.31.0 제거 → CLI 가 유일 UI surface). **code**: `derivation.rs` 모듈 주석 kind 목록 `{embedding,alias,korean_tokens}` → `{embedding,ocr,caption}` (source-of-truth 정정). ## 검증 - 독립 doc-accuracy 감사: config 기본값 5종(llm `gemma4:e4b` / embedding `multilingual-e5-large` 1024d / rag `rag-v4` / chunker `md-heading-v2` / OCR `ollama-vision`)·CLI Cmd enum 전 표면·crate 20개·migration V015·derivation kind 를 코드와 전수 대조 → 본 PR 의 2건(MCP 목록·derivation 주석) 외 잔여 staleness **0**. 5종 기본값은 kebab-config 의 assertion 테스트로 가드됨. - `cargo build -p kebab-core` (derivation 주석 변경) 컴파일 클린. ## 비범위 - 코드 동작 변경 없음 (문서 + 주석 1줄 + 프로젝트 지침). ## 시험 항목 (Test Plan) - [ ] `kebab --version` 과 README 버전 일치(v0.32.0). - [ ] README 명령 표 ↔ `kebab --help` 일치. Assisted-by: Claude Code
altair823 added 1 commit 2026-06-27 11:31:58 +00:00
docs: README/ARCHITECTURE v0.32.0 동기화 + CLAUDE.md README 최신성 규칙 745ac6e589 
최신 코드베이스 기준으로 사용자/아키텍처 문서 갱신:

README (사용자 설명서 수준):
- 버전 스탬프 v0.21.0 → v0.32.0 (2곳)
- 파생물 캐시 설명에 OCR/caption 캐싱 반영 (embedding 만 → embedding+vision)

ARCHITECTURE (구조 상세):
- migrations V001..V014 → V015 (drop chat_sessions, v0.31.0)
- derivation_cache kind: "embedding 만 남음" → embedding + ocr + caption (#217)
- 9개 code_*_ast_v1.rs → 단일 code_ast_v1.rs / CodeAstV1Chunker (v0.32.0 #220) — dir tree + 결정표
- MCP 도구 목록 4개 → 8개 (schema/doctor/search/bulk_search/ask/fetch/ingest_file/ingest_stdin)
- stale /build/dogfood 경로 → 실 경로/HOTFIXES 참조

CLAUDE.md:
- "README 최신성 hard requirement" 명문화 — 기능 추가/변경/삭제·사용자 표면 변경 시
  그 PR 에서 README 동기화, 제거된 surface 는 README 에서도 제거. 단 깊이는
  "사용자 설명서" 수준이고 아키텍처는 docs/ARCHITECTURE.md 에 — altitude 경계 명시.
- stale TUI bullet 정정 (kebab tui 는 v0.31.0 제거 → CLI 가 유일 UI surface)

code: derivation.rs 모듈 주석의 kind 목록 {embedding,alias,korean_tokens} →
{embedding,ocr,caption} (source-of-truth 주석 정정).

독립 doc-accuracy 감사로 config 기본값(llm/embedding/rag/chunker/ocr)·CLI 표면·
crate 목록·migration·cache kind 전수 대조 — 위 2건 외 잔여 staleness 0.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012Mc6W1fgsrbFKTsqA6P8La
claude-reviewer-01 approved these changes 2026-06-27 11:32:17 +00:00
claude-reviewer-01 left a comment
Member
Copy Link

독립 doc-accuracy 감사 기반 검증 후 APPROVE.

감사가 코드와 전수 대조한 결과:

  • config 기본값 5종(llm gemma4:e4b / embedding multilingual-e5-large 1024d / rag-v4 / md-heading-v2 / ollama-vision) 전부 README·ARCHITECTURE 와 일치(kebab-config assertion 테스트로 가드).
  • CLI Cmd enum 전 표면 ↔ README 명령 표 일치, 제거 플래그(--no-cache/search --explain/kebab tui) README 미참조.
  • crate 20개·migration V015·derivation kind(embedding/ocr/caption) 일치.
  • 감사가 잡은 2건(ARCHITECTURE MCP 목록 4→8, derivation.rs 주석 kind) 정정 반영 확인 → 잔여 staleness 0.

altitude 경계(사용법=README, 구조=ARCHITECTURE)도 CLAUDE.md 에 명문화됨. 머지 동의합니다.

독립 doc-accuracy 감사 기반 검증 후 APPROVE. 감사가 코드와 전수 대조한 결과: - config 기본값 5종(llm gemma4:e4b / embedding multilingual-e5-large 1024d / rag-v4 / md-heading-v2 / ollama-vision) 전부 README·ARCHITECTURE 와 일치(kebab-config assertion 테스트로 가드). - CLI Cmd enum 전 표면 ↔ README 명령 표 일치, 제거 플래그(--no-cache/search --explain/kebab tui) README 미참조. - crate 20개·migration V015·derivation kind(embedding/ocr/caption) 일치. - 감사가 잡은 2건(ARCHITECTURE MCP 목록 4→8, derivation.rs 주석 kind) 정정 반영 확인 → 잔여 staleness 0. altitude 경계(사용법=README, 구조=ARCHITECTURE)도 CLAUDE.md 에 명문화됨. 머지 동의합니다.
altair823 merged commit f8ef790b83 into main 2026-06-27 11:35:09 +00:00
altair823 deleted branch docs/sync-readme-architecture-v0-32-0 2026-06-27 11:35:10 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
claude-reviewer-01
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
altair823 claude-reviewer-01
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: altair823-org/kebab#224
Delete Branch "docs/sync-readme-architecture-v0-32-0"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?