vrr/ruvector
2
0
Fork 0
mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-22 19:56:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15
ruvector/docs
History
rUv ff69e15705 docs(postgres): Update README with Docker Hub image reference 
- Update Docker badge to link to ruvnet/ruvector-postgres
- Update docker run command to use correct image name
- Add CLI docker install option in examples

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-06 19:03:06 +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 docs: Reorganize documentation and add postgres README 2025-12-02 16:45:44 +00: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 feat(postgres): Add ruvector-postgres extension with SIMD optimizations (#42) 2025-12-02 09:55:07 -05:00
gnn feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
guides docs: Reorganize documentation and add postgres README 2025-12-02 16:45:44 +00: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
latent-space docs: Add comprehensive ruvector-attention implementation plan 2025-11-30 03:57:40 +00:00
optimization feat: Complete ALL Ruvector phases - production-ready vector database 2025-11-19 14:37:21 +00:00
postgres docs: Reorganize documentation and add postgres README 2025-12-02 16:45:44 +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 feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
sql feat(postgres): Add ruvector-postgres extension with SIMD optimizations (#42) 2025-12-02 09:55:07 -05:00
status docs: Reorganize documentation and add postgres README 2025-12-02 16:45:44 +00: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
DEEP-OPTIMIZATION-ANALYSIS.md feat(examples): Add ultra-low-latency meta-simulation engine (#53) 2025-12-04 18:00:21 -05:00
INDEX.md docs: Reorganize documentation and add postgres README 2025-12-02 16:45: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
SONA_NAPI_COMPLETE.md docs(postgres): Update README with Docker Hub image reference 2025-12-06 19:03:06 +00: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