ruvector/docs

RuVector Documentation

Complete documentation for RuVector, the high-performance Rust vector database with global scale capabilities.

📚 Documentation Structure

docs/
├── adr/                    # Architecture Decision Records
├── analysis/               # Research & analysis docs
├── api/                    # API references (Rust, Node.js, Cypher)
├── architecture/           # System design docs
├── benchmarks/             # Performance benchmarks & results
├── cloud-architecture/     # Cloud deployment guides
├── code-reviews/           # Code review documentation
├── dag/                    # DAG implementation
├── development/            # Developer guides
├── examples/               # SQL examples
├── gnn/                    # GNN/Graph implementation
├── guides/                 # User guides & tutorials
├── hnsw/                   # HNSW index documentation
├── hooks/                  # Hooks system documentation
├── implementation/         # Implementation details & summaries
├── integration/            # Integration guides
├── nervous-system/         # Nervous system architecture
├── optimization/           # Performance optimization guides
├── plans/                  # Implementation plans
├── postgres/               # PostgreSQL extension docs
├── project-phases/         # Development phases
├── publishing/             # NPM publishing guides
├── research/               # Research documentation
├── ruvllm/                 # RuVLLM documentation
├── security/               # Security audits & reports
├── sparse-inference/       # Sparse inference docs
├── sql/                    # SQL examples
├── testing/                # Testing documentation
└── training/               # Training & LoRA docs

Getting Started

• guides/GETTING_STARTED.md - Getting started guide
• guides/BASIC_TUTORIAL.md - Basic tutorial
• guides/INSTALLATION.md - Installation instructions
• guides/AGENTICDB_QUICKSTART.md - AgenticDB quick start
• guides/wasm-api.md - WebAssembly API documentation

Architecture & Design

• architecture/ - System architecture details
• cloud-architecture/ - Global cloud deployment
• adr/ - Architecture Decision Records
• nervous-system/ - Nervous system architecture

API Reference

• api/RUST_API.md - Rust API reference
• api/NODEJS_API.md - Node.js API reference
• api/CYPHER_REFERENCE.md - Cypher query reference

Performance & Benchmarks

• benchmarks/ - Performance benchmarks & results
• optimization/ - Performance optimization guides
• analysis/ - Research & analysis docs

Security

• security/ - Security audits & reports

Implementation

• implementation/ - Implementation details & summaries
• integration/ - Integration guides
• code-reviews/ - Code review documentation

Specialized Topics

• gnn/ - GNN/Graph implementation
• hnsw/ - HNSW index documentation
• postgres/ - PostgreSQL extension docs
• ruvllm/ - RuVLLM documentation
• training/ - Training & LoRA docs

Development

• development/CONTRIBUTING.md - Contribution guidelines
• development/MIGRATION.md - Migration guide
• testing/ - Testing documentation
• publishing/ - NPM publishing guides

Research

• research/ - Research documentation
  • cognitive-frontier/ - Cognitive frontier research
  • gnn-v2/ - GNN v2 research
  • latent-space/ - HNSW & attention research
  • mincut/ - MinCut algorithm research

---

🚀 Quick Links

For New Users

1. Start with Getting Started Guide
2. Try the Basic Tutorial
3. Review API Documentation

For Cloud Deployment

1. Read Architecture Overview
2. Follow Deployment Guide
3. Apply Performance Optimizations

For Contributors

1. Read Contributing Guidelines
2. Review Architecture Decisions
3. Check Migration Guide

For Performance Tuning

1. Review Optimization Guide
2. Run Benchmarks
3. Check Analysis

---

📊 Documentation Status

Category	Directory	Status
Getting Started	guides/	✅ Complete
Architecture	architecture/, adr/	✅ Complete
API Reference	api/	✅ Complete
Performance	benchmarks/, optimization/, analysis/	✅ Complete
Security	security/	✅ Complete
Implementation	implementation/, integration/	✅ Complete
Development	development/, testing/	✅ Complete
Research	research/	📚 Ongoing

Total Documentation: 170+ comprehensive documents across 25+ directories

---

🔗 External Resources

• GitHub Repository: https://github.com/ruvnet/ruvector
• Main README: ../README.md
• Changelog: ../CHANGELOG.md
• License: ../LICENSE

---

Last Updated: 2026-01-21 | Version: 0.1.29 | Status: Production Ready