Skip to content

Commit cebd99c

Browse files
committed
docs: move Quick Start into Table of Contents structure
- Quick Start is now section #1 after Table of Contents - Architecture moved before ToC - Better document structure: Install → Architecture → ToC → Content - Consistent with other SDKs
1 parent c9c98c2 commit cebd99c

File tree

1 file changed

+49
-5
lines changed

1 file changed

+49
-5
lines changed

README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,58 @@ pip install -e .
7070

7171
---
7272

73-
## Concurrent Embedded Mode
73+
# SochDB Python SDK Documentation
7474

75-
For web applications that need multiple processes to access the same database:
75+
LLM-Optimized Embedded Database with Native Vector Search
7676

77-
```python
78-
from sochdb import Database
77+
---
78+
79+
## Table of Contents
80+
81+
1. [Quick Start](#1-quick-start)
82+
2. [Installation](#2-installation)
83+
3. [Architecture Overview](#3-architecture-overview)
84+
4. [Core Key-Value Operations](#4-core-key-value-operations)
85+
5. [Transactions (ACID with SSI)](#5-transactions-acid-with-ssi)
86+
6. [Query Builder](#6-query-builder)
87+
7. [Prefix Scanning](#7-prefix-scanning)
88+
8. [SQL Operations](#8-sql-operations)
89+
9. [Table Management & Index Policies](#9-table-management--index-policies)
90+
10. [Namespaces & Multi-Tenancy](#10-namespaces--multi-tenancy)
91+
11. [Collections & Vector Search](#11-collections--vector-search)
92+
12. [Hybrid Search (Vector + BM25)](#12-hybrid-search-vector--bm25)
93+
13. [Graph Operations](#13-graph-operations)
94+
14. [Temporal Graph (Time-Travel)](#14-temporal-graph-time-travel)
95+
15. [Semantic Cache](#15-semantic-cache)
96+
16. [Context Query Builder (LLM Optimization)](#16-context-query-builder-llm-optimization)
97+
17. [Memory System](#17-memory-system)
98+
18. [Session Management](#18-session-management)
99+
19. [Atomic Multi-Index Writes](#19-atomic-multi-index-writes)
100+
20. [Recovery & WAL Management](#20-recovery--wal-management)
101+
21. [Checkpoints & Snapshots](#21-checkpoints--snapshots)
102+
22. [Compression & Storage](#22-compression--storage)
103+
23. [Statistics & Monitoring](#23-statistics--monitoring)
104+
24. [Distributed Tracing](#24-distributed-tracing)
105+
25. [Workflow & Run Tracking](#25-workflow--run-tracking)
106+
26. [Server Mode (gRPC Client)](#26-server-mode-grpc-client)
107+
27. [IPC Client (Unix Sockets)](#27-ipc-client-unix-sockets)
108+
28. [Standalone VectorIndex](#28-standalone-vectorindex)
109+
29. [Vector Utilities](#29-vector-utilities)
110+
30. [Data Formats (TOON/JSON/Columnar)](#30-data-formats-toonjsoncolumnar)
111+
31. [Policy Service](#31-policy-service)
112+
32. [MCP (Model Context Protocol)](#32-mcp-model-context-protocol)
113+
33. [Configuration Reference](#33-configuration-reference)
114+
34. [Error Handling](#34-error-handling)
115+
35. [Async Support](#35-async-support)
116+
36. [Building & Development](#36-building--development)
117+
37. [Complete Examples](#37-complete-examples)
118+
38. [Migration Guide](#38-migration-guide)
119+
120+
---
121+
122+
## 1. Quick Start
79123

80-
# Open in concurrent mode - multiple processes can access simultaneously
124+
### Concurrent Embedded Mode
81125
db = Database.open_concurrent("./app_data")
82126

83127
# Reads are lock-free and can run in parallel (~100ns)

0 commit comments

Comments
 (0)