mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-05-22 19:56:25 +00:00
ed2bdd014e
- Create docs/api/CYPHER_REFERENCE.md with complete Cypher query guide - Update README to highlight all capabilities in core npx ruvector package - Add Tiny Dancer (AI agent routing) to features and comparison table - Fix ruvector-wasm insertBatch to use js_sys::Array instead of serde |
||
|---|---|---|
| .. | ||
| api | ||
| architecture | ||
| benchmarks | ||
| cloud-architecture | ||
| development | ||
| getting-started | ||
| guide | ||
| optimization | ||
| project-phases | ||
| research | ||
| testing | ||
| .gitkeep | ||
| ALL_PACKAGES_STATUS.md | ||
| BENCHMARK_COMPARISON.md | ||
| BUILD_PROCESS.md | ||
| BUILD_SUMMARY.md | ||
| cli-graph-commands.md | ||
| cli-graph-implementation-summary.md | ||
| CONTRIBUTING.md | ||
| CURRENT_STATUS.md | ||
| cypher-parser-implementation.md | ||
| DEPLOYMENT_STATUS.md | ||
| gnn-layer-implementation.md | ||
| graph-wasm-setup.md | ||
| GRAPH_INTEGRATION_SUMMARY.md | ||
| GRAPH_VALIDATION_CHECKLIST.md | ||
| IMPLEMENTATION_SUMMARY.md | ||
| IMPROVEMENT_ROADMAP.md | ||
| INDEX.md | ||
| INTEGRATION-SUMMARY.md | ||
| MACOS_PACKAGES_SETUP.md | ||
| NPM_PUBLISHING.md | ||
| NPM_READY_STATUS.md | ||
| NPM_TOKEN_SETUP.md | ||
| PACKAGE-VALIDATION-REPORT.md | ||
| PHASE2_MULTIPLATFORM_COMPLETE.md | ||
| PHASE3_WASM_STATUS.md | ||
| PSYCHO-SYMBOLIC-INTEGRATION.md | ||
| PSYCHO-SYNTH-QUICK-START.md | ||
| PUBLISHING-GUIDE.md | ||
| PUBLISHING.md | ||
| PUBLISHING_COMPLETE.md | ||
| README.md | ||
| READY-TO-PUBLISH.md | ||
| ruvector-gnn-node-bindings.md | ||
| TECHNICAL_PLAN.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:
- AGENTICDB_QUICKSTART.md - Quick start for AgenticDB compatibility
- OPTIMIZATION_QUICK_START.md - Performance optimization quick guide
- AGENTICDB_API.md - AgenticDB API reference
- wasm-api.md - WebAssembly API documentation
- wasm-build-guide.md - Building WASM bindings
- advanced-features.md - Advanced features guide
- quick-fix-guide.md - Common issues and fixes
Architecture & Design
System architecture and design documentation:
- TECHNICAL_PLAN.md - Complete technical plan and architecture
- INDEX.md - Documentation index
- architecture/ - System architecture details
- cloud-architecture/ - Global cloud deployment architecture
- architecture-overview.md - 15-region topology
- scaling-strategy.md - Auto-scaling & burst handling
- infrastructure-design.md - GCP infrastructure specs
- DEPLOYMENT_GUIDE.md - Step-by-step deployment
- PERFORMANCE_OPTIMIZATION_GUIDE.md - Advanced tuning
API Reference
API documentation for different platforms:
- api/ - Core API documentation
- RUST_API.md - Rust API reference
- NODEJS_API.md - Node.js API reference
User Guides
Comprehensive user guides:
- guide/ - User guides
- GETTING_STARTED.md - Getting started guide
- BASIC_TUTORIAL.md - Basic tutorial
- ADVANCED_FEATURES.md - Advanced features
- INSTALLATION.md - Installation instructions
Performance & Optimization
Performance tuning and benchmarking:
- optimization/ - Performance optimization guides
- BUILD_OPTIMIZATION.md - Build optimizations
- IMPLEMENTATION_SUMMARY.md - Implementation details
- OPTIMIZATION_RESULTS.md - Optimization results
- PERFORMANCE_TUNING_GUIDE.md - Performance tuning
- benchmarks/ - Benchmarking documentation
- BENCHMARKING_GUIDE.md - How to run benchmarks
Development
Contributing and development guides:
- development/ - Development documentation
- CONTRIBUTING.md - Contribution guidelines
- MIGRATION.md - Migration guide
- FIXING_COMPILATION_ERRORS.md - Troubleshooting compilation
Testing
Testing documentation and reports:
- testing/ - Testing documentation
- TDD_TEST_SUITE_SUMMARY.md - TDD test suite summary
- integration-testing-report.md - Integration test report
Project History
Historical project phase documentation:
- project-phases/ - Project phase documentation
- phase2_hnsw_implementation.md - Phase 2: HNSW
- PHASE3_SUMMARY.md - Phase 3 summary
- phase4-implementation-summary.md - Phase 4 summary
- PHASE5_COMPLETE.md - Phase 5 complete
- phase5-implementation-summary.md - Phase 5 summary
- PHASE6_ADVANCED.md - Phase 6 advanced features
- PHASE6_COMPLETION_REPORT.md - Phase 6 report
- PHASE6_SUMMARY.md - Phase 6 summary
Implementation Summary
- IMPLEMENTATION_SUMMARY.md - Complete implementation overview for global streaming
🚀 Quick Links
For New Users
- Start with Getting Started Guide
- Try the Basic Tutorial
- Review API Documentation
For Cloud Deployment
- Read Architecture Overview
- Follow Deployment Guide
- Apply Performance Optimizations
For Contributors
- Read Contributing Guidelines
- Review Technical Plan
- Check Migration Guide
For Performance Tuning
- Review Optimization Guide
- Run Benchmarks
- 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
- GitHub Repository: https://github.com/ruvnet/ruvector
- Main README: ../README.md
- Changelog: ../CHANGELOG.md
- License: ../LICENSE
Last Updated: 2025-11-20 | Version: 0.1.0 | Status: Production Ready