vrr/ruvector
2
0
Fork 0
mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-23 04:27:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15
ruvector/docs
History
rUv ed35626265 feat(rvf): complete ADR-032 phases 1-3 — epoch, lease, ID map, MCP tools, compat tests 
Phase 2 Rust: full epoch reconciliation (EpochTracker with AtomicU64, 23 tests),
writer lease with file lock and PID-based stale detection (12 tests),
direct ID mapping trait with DirectIdMap and OffsetIdMap (20 tests).

Phase 2 JS: createWithRvf/saveToRvf/loadFromRvf factories, BrowserWriterLease
with IndexedDB heartbeat, rvf-migrate and rvf-rebuild CLI commands, epoch sync
helpers. +541 lines to index.ts, new cli-rvf.ts (363 lines).

Phase 3: 3 MCP rvlite tools (rvlite_sql, rvlite_cypher, rvlite_sparql),
CI wasm-dedup-check workflow, 6 cross-platform compat tests, shared peer dep.

Phase 1: 4 RVF smoke integration tests (full lifecycle, cosine, multi-restart,
metadata). Node.js CLI smoke test script.

81 new Rust tests passing. ADR-032 checklist fully complete.

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-02-14 22:08:05 +00:00
..
adr feat(rvf): complete ADR-032 phases 1-3 — epoch, lease, ID map, MCP tools, compat tests 2026-02-14 22:08:05 +00:00
analysis docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
api docs: Add Cypher reference, include Tiny Dancer, fix WASM build 2025-11-26 12:54:04 +00:00
architecture Merge origin/main into claude/quantum-engine-adrs-6OsEO - resolve Cargo.toml conflict 2026-02-08 17:04:57 +00:00
benchmarks docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
cloud-architecture Implement global streaming optimization for 500M concurrent streams 2025-11-20 18:51:26 +00:00
code-reviews docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
dag docs(dag): add comprehensive Neural DAG Learning implementation plan 2025-12-29 22:15:55 +00:00
development feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
examples feat(nervous-system): Complete bio-inspired neural architecture implementation 2025-12-28 04:05:08 +00:00
gnn feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
guides feat(postgres): Add HNSW index and embedding functions support (#62) 2025-12-09 11:14:52 -05:00
hnsw docs: Reorganize documentation and add postgres README 2025-12-02 16:45:44 +00:00
hooks feat(cli): Implement full hooks system in Rust CLI 2025-12-27 01:08:36 +00:00
implementation docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
integration docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
nervous-system docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
optimization docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
plans/subpolynomial-time-mincut chore(docs): Clean up and reorganize documentation structure 2025-12-25 19:39:44 +00:00
postgres Feat/ruvector postgres v2 (#82) 2025-12-25 17:02:55 -05:00
project-phases Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
publishing feat(training): RuvLTRA v2.4 Ecosystem Edition - 100% routing accuracy (#123) 2026-01-20 20:08:30 -05:00
research feat(rvf): RuVector Format — Universal Cognitive Container SDK (#166) 2026-02-14 13:14:49 -05:00
ruvllm docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
security docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
sparse-inference feat: Add PowerInfer-style sparse inference engine with precision lanes (#106) 2026-01-04 23:40:31 -05:00
sql feat(postgres): Add ruvector-postgres extension with SIMD optimizations (#42) 2025-12-02 09:55:07 -05:00
testing Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
training docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
.gitkeep Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
INDEX.md docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
README.md docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
REPO_STRUCTURE.md docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00

README.md

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

Architecture & Design

API Reference

Performance & Benchmarks

Security

Implementation

Specialized Topics

Development

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

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