vrr/ruvector
2
0
Fork 0
mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-24 05:43:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 19
ruvector/docs
History
rUv d991165868 feat(postgres): Add hybrid search, multi-tenancy, and self-healing specs 
Three high-impact additions to RuVector Postgres v2:

## 11-hybrid-search.md - BM25 + Vector Fusion
- Single query combines semantic and keyword search
- Proper BM25 implementation (not just ts_rank)
- Fusion algorithms: RRF (default), linear, learned
- Integrity-aware degradation (stress → single branch)
- Parallel branch execution
- GUC configuration

## 12-multi-tenancy.md - First-Class Tenant Isolation
- SET ruvector.tenant_id for transparent scoping
- Isolation levels: shared, partition, dedicated
- Automatic promotion based on vector count
- Per-tenant integrity (stress in one doesn't affect others)
- Per-tenant contracted graphs
- Resource quotas and rate limiting
- Fair scheduling (no noisy neighbors)
- RLS integration for defense in depth

## 13-self-healing.md - Automated Remediation
- Completes the control loop: sensor → actuator
- Problem classification from witness edges:
  - Hotspot congestion
  - Centroid skew
  - Replication lag
  - Maintenance contention
  - Index fragmentation
  - Memory pressure
- Built-in strategies:
  - Rebalance partitions
  - Pause maintenance jobs
  - Throttle ingestion
  - Scale read replicas (K8s)
  - Compact fragmented indexes
- Safety: reversible actions, blast radius limits
- Learning: outcome tracking, strategy weight updates
- The key insight: "We built the sensor. Now we build the actuator."

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-25 21:10:28 +00:00
..
api docs: Add Cypher reference, include Tiny Dancer, fix WASM build 2025-11-26 12:54:04 +00:00
architecture docs: Reorganize documentation and add postgres README 2025-12-02 16:45:44 +00:00
benchmarks feat(postgres): Add HNSW index and embedding functions support (#62) 2025-12-09 11:14:52 -05:00
cloud-architecture Implement global streaming optimization for 500M concurrent streams 2025-11-20 18:51:26 +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 chore(docs): Clean up and reorganize documentation structure 2025-12-25 19:39:44 +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
implementation feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
integration feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
optimization chore(docs): Clean up and reorganize documentation structure 2025-12-25 19:39:44 +00:00
plans/subpolynomial-time-mincut chore(docs): Clean up and reorganize documentation structure 2025-12-25 19:39:44 +00:00
postgres feat(postgres): Add hybrid search, multi-tenancy, and self-healing specs 2025-12-25 21:10:28 +00:00
project-phases Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
publishing feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
research chore(docs): Clean up and reorganize documentation structure 2025-12-25 19:39:44 +00: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
.gitkeep Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
INDEX.md chore(docs): Clean up and reorganize documentation structure 2025-12-25 19:39:44 +00:00
README.md Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
REPO_STRUCTURE.md feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00

README.md

RuVector Documentation

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

📚 Documentation Structure

Getting Started

Quick start guides and tutorials for new users:

Architecture & Design

System architecture and design documentation:

API Reference

API documentation for different platforms:

User Guides

Comprehensive user guides:

Performance & Optimization

Performance tuning and benchmarking:

Development

Contributing and development guides:

Testing

Testing documentation and reports:

Project History

Historical project phase documentation:

Implementation Summary

🚀 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 Technical Plan
  3. Check Migration Guide

For Performance Tuning

  1. Review Optimization Guide
  2. Run Benchmarks
  3. Apply Query Optimizations

📊 Documentation Status

Category Files Status
Getting Started 7 ✅ Complete
Architecture 11 ✅ Complete
API Reference 2 ✅ Complete
User Guides 4 ✅ Complete
Optimization 4 ✅ Complete
Development 3 ✅ Complete
Testing 2 ✅ Complete
Project Phases 8 📚 Historical

Total Documentation: 40+ comprehensive documents

🔗 External Resources

Last Updated: 2025-11-20 | Version: 0.1.0 | Status: Production Ready