Skip to content

NodeDB-Lab/nodedb-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NodeDB Documentation

Documentation site for NodeDB — the distributed hybrid database for multi-modal AI and agentic workloads.

Built with Oxidoc. Published at nodedb.dev.

Structure

docs/
├── introduction/       Getting started, installation, Docker
├── architecture/       Three-plane model, storage, cluster topology
├── data-modeling/      Engines (Vector, Graph, Document, Columnar, KV, FTS, CRDT), indexes
├── sql/                SQL reference, engine-specific queries, EXPLAIN
├── real-time/          LIVE SELECT, change streams, webhooks, cron
├── connectivity/       pgwire, HTTP, native protocol, RESP, ILP, client libraries
├── administration/     Config, security (RBAC/RLS/TLS), operations, monitoring
├── crdt-sync/          Edge sync, conflict policies, offline sync
└── reference/          Error codes, wire specs, WAL formats, limits

Development

# Install Oxidoc
cargo install oxidoc

# Serve locally with hot reload
oxidoc dev

# Build for production
oxidoc build

License

Apache-2.0

About

Documentation site for NodeDB

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages