docs: add Korean README #4

Merged
altair823 merged 1 commits from docs/readme into main 2026-04-27 23:51:44 +00:00
Owner

요약

한국어 README 추가. 211 lines. 코드 변경 없음.

내용

  • 상태 명시: spec 동결 끝, 코드 0줄, P0 미시작
  • 명령 요약: 7개 user-facing CLI (init/ingest/search/ask/inspect/doctor/eval)
  • 결정 표: 14개 lock 된 결정 (언어/스토리지/모델/UI 등)
  • 의존성 그래프: design §8 module-boundary 시각화
  • Phase 로드맵: P0~P9, 직렬/병렬 표기, 각 phase 의 핵심 산출 crate
  • 디렉토리 구조: 현재 + P0 이후 모습
  • 빌드/실행 snippet: P0 완료 후 가정
  • Non-goals: SaaS / multi-workspace / LLM-as-judge 등 명시 제외
  • 외부 AI 통합 path: skill / MCP / HTTP 옵션
  • 기여 워크플로우: spec 변경 / task 추가 / 버전 cascade rule
  • 링크: frozen design / plan / INDEX 로 cross-ref

검토 포인트

  • 사용자 메인 진입점이 됨. 첫 인상 + 정확성 중요
  • 코드 0줄 사실을 명확히 표시 ("현재는 P0 미시작 — 위 명령 모두 동작하지 않는다")
  • License 미정 표기 (P0 lock 시 결정)

frozen design 변경 0건. spec/task 미수정.

## 요약 한국어 README 추가. 211 lines. 코드 변경 없음. ## 내용 - **상태 명시**: spec 동결 끝, 코드 0줄, P0 미시작 - **명령 요약**: 7개 user-facing CLI (init/ingest/search/ask/inspect/doctor/eval) - **결정 표**: 14개 lock 된 결정 (언어/스토리지/모델/UI 등) - **의존성 그래프**: design §8 module-boundary 시각화 - **Phase 로드맵**: P0~P9, 직렬/병렬 표기, 각 phase 의 핵심 산출 crate - **디렉토리 구조**: 현재 + P0 이후 모습 - **빌드/실행 snippet**: P0 완료 후 가정 - **Non-goals**: SaaS / multi-workspace / LLM-as-judge 등 명시 제외 - **외부 AI 통합 path**: skill / MCP / HTTP 옵션 - **기여 워크플로우**: spec 변경 / task 추가 / 버전 cascade rule - **링크**: frozen design / plan / INDEX 로 cross-ref ## 검토 포인트 - 사용자 메인 진입점이 됨. 첫 인상 + 정확성 중요 - 코드 0줄 사실을 명확히 표시 ("현재는 P0 미시작 — 위 명령 모두 동작하지 않는다") - License 미정 표기 (P0 lock 시 결정) frozen design 변경 0건. spec/task 미수정.
altair823 added 1 commit 2026-04-27 23:50:58 +00:00
- Status (spec frozen, P0 not started)
- Command summary (init/ingest/search/ask/inspect/doctor/eval)
- Locked decisions table (Rust 2024, SQLite+FTS5, LanceDB, fastembed, Ollama, whisper, Tauri)
- Dependency graph + module-boundary references
- Phase roadmap (P0..P9) with crates per phase
- Directory layout (current + post-P0)
- Build/run snippet (post-P0)
- Non-goals
- External AI integration paths (skill / MCP / HTTP)
- Contribution workflow + license note
- Cross-links to frozen design / plan / INDEX
claude-reviewer-01 approved these changes 2026-04-27 23:51:32 +00:00
claude-reviewer-01 left a comment
Member

APPROVE — README

깔끔한 한국어 README. 211 lines 적정 분량. 코드/spec 변경 0건.

핵심 강점: "현재 P0 미시작" 을 두 곳 (intro + 빌드 섹션) 에 명시 — README 이 흔히 빠지는 "미래 동작 현재형 서술" 함정 회피.

minor concern: License 미정. MIT OR Apache-2.0 으로 lock 권장 (frozen design 의 workspace.package 와 정합). P0 PR 에서 같이 처리 가능.

inline 5개 (4 praise + 1 minor concern). 머지 가능.

## APPROVE — README 깔끔한 한국어 README. 211 lines 적정 분량. 코드/spec 변경 0건. 핵심 강점: \"현재 P0 미시작\" 을 두 곳 (intro + 빌드 섹션) 에 명시 — README 이 흔히 빠지는 \"미래 동작 현재형 서술\" 함정 회피. minor concern: License 미정. `MIT OR Apache-2.0` 으로 lock 권장 (frozen design 의 workspace.package 와 정합). P0 PR 에서 같이 처리 가능. inline 5개 (4 praise + 1 minor concern). 머지 가능.
@@ -0,0 +2,4 @@
> **상태:** spec 동결 단계. 코드 0줄. 30 component task spec 모두 작성/리뷰/머지 완료. 다음 단계 = P0 구현.
`kb` 는 개인용 로컬 knowledge base + RAG 도구다. Markdown / PDF / 이미지 / 음성을 한 곳에 색인하고, 의미 검색 + citation 포함 LLM 답변을 단일 binary 로 제공한다. 모든 추론은 로컬 (Ollama / fastembed / whisper.cpp) 에서 돌아간다.

Praise. 첫 줄에 "코드 0줄, spec 동결, P0 미시작" 상태 명시 — 처음 들어오는 사람이 이게 working binary 인지 design phase 인지 즉시 알 수 있음. 흔히 README 가 미래의 동작을 현재형으로 써서 혼동 주는데, 이건 명확함.

**Praise.** 첫 줄에 "코드 0줄, spec 동결, P0 미시작" 상태 명시 — 처음 들어오는 사람이 이게 working binary 인지 design phase 인지 즉시 알 수 있음. 흔히 README 가 미래의 동작을 현재형으로 써서 혼동 주는데, 이건 명확함.
@@ -0,0 +78,4 @@
| Phase | 내용 | 핵심 산출 crate | 선행 |
|-------|------|----------------|------|
| **P0** | Workspace 뼈대 + 도메인 계약 + ID recipe | `kb-core`, `kb-parse-types`, `kb-config`, `kb-app`, `kb-cli` | |

Praise. Phase 로드맵 표가 각 phase 의 산출 crate + 선행 의존을 한눈에. P0P5 직렬, P6P9 병렬 가능 표기도 정확. INDEX.md 의 component 분해와 일관.

**Praise.** Phase 로드맵 표가 각 phase 의 산출 crate + 선행 의존을 한눈에. P0~P5 직렬, P6~P9 병렬 가능 표기도 정확. INDEX.md 의 component 분해와 일관.
@@ -0,0 +159,4 @@
./target/release/kb ask "내 KB 설계에서 저장소 전략은?"
```
**현재는 P0 미시작 — 위 명령 모두 동작하지 않는다.** spec 만 동결됐다.

Praise. 같은 메시지가 빌드/실행 섹션에서 다시 한번 명시됨 ("현재는 P0 미시작 — 위 명령 모두 동작하지 않는다"). 사용자가 cargo build 실행하고 "왜 빌드 실패?" 라고 안 묻게 됨.

**Praise.** 같은 메시지가 빌드/실행 섹션에서 다시 한번 명시됨 ("현재는 P0 미시작 — 위 명령 모두 동작하지 않는다"). 사용자가 cargo build 실행하고 "왜 빌드 실패?" 라고 안 묻게 됨.
@@ -0,0 +175,4 @@
- desktop app `kb://` protocol handler — P+
---

Praise. 외부 AI 통합 3 path (skill / MCP / HTTP) 가 구체적이고 우선순위 명시. MCP 가 stdio JSON-RPC 라는 구체 메커니즘까지 — "언젠가 통합될 수도" 가 아니라 "이렇게 통합한다" 톤.

**Praise.** 외부 AI 통합 3 path (skill / MCP / HTTP) 가 구체적이고 우선순위 명시. MCP 가 stdio JSON-RPC 라는 구체 메커니즘까지 — "언젠가 통합될 수도" 가 아니라 "이렇게 통합한다" 톤.
@@ -0,0 +199,4 @@
## 라이선스
미정 (frozen design 에는 `MIT OR Apache-2.0` 가 workspace.package 의 license 필드로 권장됨; P0 lock 시 결정).

Concern (minor). License 미정 + "P0 lock 시 결정" 인데, frozen design 의 [workspace.package] 가 이미 MIT OR Apache-2.0 권장 — P0 시작 전 이걸 lock 하는 게 더 안전. 외부 기여자가 미정 라이선스 repo 에 PR 망설이는 일반 패턴 회피.

**Concern (minor).** License 미정 + "P0 lock 시 결정" 인데, frozen design 의 `[workspace.package]` 가 이미 `MIT OR Apache-2.0` 권장 — P0 시작 전 이걸 lock 하는 게 더 안전. 외부 기여자가 미정 라이선스 repo 에 PR 망설이는 일반 패턴 회피.
altair823 merged commit d3cb06f60d into main 2026-04-27 23:51:44 +00:00
Sign in to join this conversation.
No Reviewers
No Label
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: altair823-org/kebab#4