vrr/ruvector
2
0
Fork 0
mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-23 21:25:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 19
ruvector/docs/README.md
rUv eda7df86b6 docs: update guides to match current API surface and versions 
- GETTING_STARTED.md: rewrite to cover both ruvector-core (VectorDB) and
  rvf-runtime (RvfStore) APIs, add package registry table, fix SearchQuery
  fields (ef_search not include_vectors), results use .score not .distance
- INSTALLATION.md: update crate version 0.1.0 -> 2.0, fix npm scoped
  package names (@ruvector/*), remove non-existent Docker image, update
  Rust version requirement to 1.80+, fix CLI docs to match actual subcommands
- BASIC_TUTORIAL.md: fix SearchQuery.include_vectors -> ef_search, fix
  result.distance -> result.score, fix HnswConfig/QuantizationConfig field
  access patterns (options.hnsw -> options.hnsw_config, wrap in Some())
- ADVANCED_FEATURES.md: same field name fixes, fix QuantizationConfig
  wrapping in Some(), remove references to non-existent mmap_vectors field
- docs/README.md: update version to 2.0.4/0.1.100, update date

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-02-26 16:05:29 +00:00

5.9 KiB
Raw Blame History

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-02-26 | Version: 2.0.4 (core) / 0.1.100 (npm) | Status: Production Ready