Skip to content

Commit 99e2573

Browse files
committed
docs: add repository README for the documentation site
1 parent 09733b6 commit 99e2573

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# NodeDB Documentation
2+
3+
Documentation site for [NodeDB](https://github.com/NodeDB-Lab/nodedb) — the distributed hybrid database for multi-modal AI and agentic workloads.
4+
5+
Built with [Oxidoc](https://oxidoc.dev). Published at [nodedb.dev](https://nodedb.dev).
6+
7+
## Structure
8+
9+
```
10+
docs/
11+
├── introduction/ Getting started, installation, Docker
12+
├── architecture/ Three-plane model, storage, cluster topology
13+
├── data-modeling/ Engines (Vector, Graph, Document, Columnar, KV, FTS, CRDT), indexes
14+
├── sql/ SQL reference, engine-specific queries, EXPLAIN
15+
├── real-time/ LIVE SELECT, change streams, webhooks, cron
16+
├── connectivity/ pgwire, HTTP, native protocol, RESP, ILP, client libraries
17+
├── administration/ Config, security (RBAC/RLS/TLS), operations, monitoring
18+
├── crdt-sync/ Edge sync, conflict policies, offline sync
19+
└── reference/ Error codes, wire specs, WAL formats, limits
20+
```
21+
22+
## Development
23+
24+
```bash
25+
# Install Oxidoc
26+
cargo install oxidoc
27+
28+
# Serve locally with hot reload
29+
oxidoc dev
30+
31+
# Build for production
32+
oxidoc build
33+
```
34+
35+
## License
36+
37+
Apache-2.0

0 commit comments

Comments
 (0)