Skip to content

Commit e576ab3

Browse files
committed
docs: friendly guide + concepts + tutorial + docs index
Add 4 new documents aimed at different audiences: - docs/GUIDE.md — friendly overview with zero jargon. Explains what Synaptic Memory is, why it exists, how knowledge graphs work, and the 3-pillar design (code as data, BYO, zero-LLM indexing). Good for a first encounter. - docs/CONCEPTS.md — deep dive into 3rd-gen GraphRAG, the 9-step search pipeline, graph structure (node kinds, edge kinds, weights), multi-turn agent design, and why SQLite was chosen as the default. For engineers who want to understand the "why". - docs/TUTORIAL.md — 30-minute hands-on walkthrough. CSV single table → multi-table with FK → structured tools → full agent loop → MCP server → quality tuning → custom benchmarks. Copy-paste runnable code all the way through. - docs/README.md — index file with purpose-driven links. Points readers to the right doc based on their goal (first-time user, engineer, evaluator, etc.). Also added a Documentation section to README.md and README.ko.md linking to all docs/*.md files.
1 parent e96e5f5 commit e576ab3

6 files changed

Lines changed: 1670 additions & 0 deletions

File tree

README.ko.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,17 @@ StorageBackend (Protocol)
253253

254254
---
255255

256+
## 문서
257+
258+
| 문서 | 내용 |
259+
|------|------|
260+
| [docs/GUIDE.md](docs/GUIDE.md) | 친절한 전체 안내서 (처음 접하는 사람용) |
261+
| [docs/TUTORIAL.md](docs/TUTORIAL.md) | 30분 단계별 실습 |
262+
| [docs/CONCEPTS.md](docs/CONCEPTS.md) | 3세대 GraphRAG + 파이프라인 심화 |
263+
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | 신경망 영감 초기 설계 |
264+
| [docs/COMPARISON.md](docs/COMPARISON.md) | GraphRAG/LightRAG와 비교 |
265+
| [docs/ROADMAP.md](docs/ROADMAP.md) | 향후 로드맵 |
266+
256267
## 개발
257268

258269
```bash

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,17 @@ Agent tools (29) → MCP server → LLM agent
253253

254254
---
255255

256+
## Documentation
257+
258+
| Doc | What it is |
259+
|-----|-----------|
260+
| [docs/GUIDE.md](docs/GUIDE.md) | Friendly intro — what/why/how, zero jargon |
261+
| [docs/TUTORIAL.md](docs/TUTORIAL.md) | 30-minute hands-on walkthrough |
262+
| [docs/CONCEPTS.md](docs/CONCEPTS.md) | 3rd-gen GraphRAG + pipeline internals |
263+
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | Original neural-inspired design |
264+
| [docs/COMPARISON.md](docs/COMPARISON.md) | vs GraphRAG / LightRAG / LazyGraphRAG |
265+
| [docs/ROADMAP.md](docs/ROADMAP.md) | Future plans |
266+
256267
## Dev
257268

258269
```bash

0 commit comments

Comments
 (0)