Commit e576ab3
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
253 | 253 | | |
254 | 254 | | |
255 | 255 | | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
256 | 267 | | |
257 | 268 | | |
258 | 269 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
253 | 253 | | |
254 | 254 | | |
255 | 255 | | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
256 | 267 | | |
257 | 268 | | |
258 | 269 | | |
| |||
0 commit comments