mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-23 12:55:26 +00:00

rUv 116fc9c7b4 chore(docs): Clean up and reorganize documentation structure

Changes:
- Remove outdated status/ directory (old build status from Dec 2)
- Remove temporary fix docs (BENCHMARK_FIXES, quantization-fixes, SONA_NAPI_COMPLETE)
- Move cognitive-frontier/ to research/cognitive-frontier/
- Move latent-space/ to research/latent-space/
- Move localkcut docs to research/mincut/
- Move PGLITE/WASM architecture docs to research/
- Move monitoring_example.md to examples/
- Move DEEP-OPTIMIZATION-ANALYSIS.md to optimization/
- Add subpolynomial-time-mincut plans to docs/plans/
- Update INDEX.md with new structure and version 0.1.29

Documentation structure now:
- docs/research/ - All research docs (cognitive-frontier, latent-space, mincut, gnn-v2)
- docs/examples/ - Example documentation
- docs/optimization/ - Performance optimization
- docs/plans/ - Implementation plans

Reduced from 186 to 172 markdown files.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2025-12-25 19:39:44 +00:00

13 KiB

Raw Blame History

Ruvector Documentation Index

Complete index of all Ruvector documentation.

Quick Links

Getting Started - Start here!
Installation - Platform-specific installation
API Reference - Complete API documentation
Examples - Working code examples
Contributing - How to contribute

Documentation Structure

docs/
├── api/                    # API references (Rust, Node.js, Cypher)
├── architecture/           # System design docs
├── benchmarks/             # Performance benchmarks
├── cloud-architecture/     # Cloud deployment guides
├── development/            # Developer guides
├── examples/               # SQL examples
├── gnn/                    # GNN/Graph implementation
├── guides/                 # User guides & tutorials
├── hnsw/                   # HNSW index documentation
├── implementation/         # Implementation details
├── integration/            # Integration guides
├── optimization/           # Performance optimization
├── plans/                  # Implementation plans
├── postgres/               # PostgreSQL extension docs
│   └── zero-copy/          # Zero-copy memory docs
├── project-phases/         # Development phases
├── publishing/             # NPM publishing guides
├── research/               # Research documentation
│   ├── cognitive-frontier/ # Cognitive frontier research
│   ├── gnn-v2/             # GNN v2 research plans
│   ├── latent-space/       # HNSW & attention research
│   └── mincut/             # MinCut algorithm research
├── sql/                    # SQL examples
└── testing/                # Testing documentation

User Guides

Getting Started

Getting Started Guide - Quick introduction to Ruvector
Installation Guide - Installation for Rust, Node.js, WASM, CLI
Basic Tutorial - Step-by-step tutorial with examples
Advanced Features Guide - Hybrid search, quantization, MMR, filtering

Quick Starts

AgenticDB Quickstart - Quick start for AgenticDB
AgenticDB API - Detailed AgenticDB API documentation
Optimization Quick Start - Performance optimization guide
Quick Fix Guide - Common issues and solutions

WASM Guides

WASM API - Browser WASM API
WASM Build Guide - Building for WASM

Migration

Migration from AgenticDB - Complete migration guide with examples

HNSW Documentation

HNSW Index - HNSW index overview
HNSW Quick Reference - Quick reference guide
HNSW Usage Example - Working examples
HNSW Implementation Summary - Implementation details
HNSW Implementation README - Detailed README

PostgreSQL Extension

Core Documentation

Operator Quick Reference - Operator reference
Parallel Query Guide - Parallel query execution
Parallel Implementation - Implementation details

SparseVec

SparseVec Quickstart - Sparse vector quick start
SparseVec Implementation - Implementation details

Zero-Copy Memory

Zero-Copy Implementation - Zero-copy overview
Zero-Copy Operators - Operator details
Zero-Copy Summary - Summary
Zero-Copy Examples - Rust examples
Memory Quick Reference - Quick reference
Memory Implementation - Memory details
Memory Guide - Comprehensive guide

Architecture Documentation

System Overview - High-level architecture and design
NPM Package Architecture - Package structure
Technical Plan - Technical roadmap
Repository Structure - Codebase organization

Cloud Architecture

Architecture Overview - Cloud design
Deployment Guide - Deployment instructions
Infrastructure Design - Infrastructure details
Scaling Strategy - Scaling approaches
Performance Optimization - Cloud performance

API Reference

Platform APIs

Rust API - Complete Rust API reference
Node.js API - Complete Node.js API reference
Cypher Reference - Cypher query language

GNN & Graph Documentation

Graph Integration Summary - Overview of graph features
Graph Validation Checklist - Validation guide
GNN Layer Implementation - Layer details
Graph Attention Implementation - Attention mechanisms
Hyperbolic Attention - Hyperbolic embeddings
Cypher Parser - Query parser
CLI Graph Commands - CLI usage
Graph WASM Setup - WASM bindings
Node Bindings - Node.js bindings
Training Utilities - Training tools

Integration Guides

Integration Summary - Integration overview
Psycho-Symbolic Integration - Symbolic AI integration
Psycho-Synth Quick Start - Quick start guide

Performance & Benchmarks

Benchmarking Guide - How to run and interpret benchmarks
Benchmark Comparison - Performance comparisons

Optimization Guides

Performance Tuning Guide - Detailed optimization guide
Build Optimization - Compilation optimizations
Optimization Results - Benchmark results
Implementation Summary - Optimization implementation

Implementation Documentation

Implementation Details

Implementation Summary - Overall implementation
Improvement Roadmap - Future plans
Security Fixes Summary - Security improvements
Overflow Fixes - Bug fixes

Phase Summaries

Phase 2: HNSW - HNSW integration
Phase 3: AgenticDB - AgenticDB layer
Phase 4: Advanced Features - Product quantization, hybrid search
Phase 5: Multi-Platform - Node.js, WASM, CLI
Phase 6: Advanced - Future features

Publishing & Deployment

Publishing Guide - How to publish packages
NPM Publishing - NPM-specific guide
NPM Token Setup - Authentication setup
Package Validation - Validation report
Publishing Status - Current status

Development

Contributing Guide - How to contribute
Security - Security guidelines
Migration Guide - Migration documentation
NPM Package Review - Package review
Fixing Compilation Errors - Troubleshooting

Testing

Test Suite Summary - Testing strategy
Integration Testing Report - Integration tests

Research & Advanced Features

Cognitive Frontier

Temporal Hypergraphs - Time-varying hyperedges with causal constraints
Federated Strange Loops - Multi-system mutual observation

Latent Space

Implementation Roadmap - Development plan
GNN Architecture Analysis - Architecture deep-dive
Attention Mechanisms Research - Research notes
Advanced Architectures - Advanced designs
Optimization Strategies - Optimization approaches
HNSW Evolution - HNSW research
HNSW Neural Augmentation - Neural features
HNSW Quantum Hybrid - Quantum computing

MinCut Research

LocalKCut Algorithm - Algorithm overview
LocalKCut Implementation - Implementation details
Paper Implementation - December 2025 paper

GNN v2 Research

Master Plan - GNN v2 overview
GNN Guided Routing - Routing research
Incremental Graph Learning - Learning approaches
Neuro-Symbolic Query - Query processing
Hyperbolic Embeddings - Embedding research
Adaptive Precision - Precision optimization
Temporal GNN - Temporal features
Graph Condensation - Condensation techniques
Native Sparse Attention - Sparse attention
Quantum-Inspired Attention - Quantum approaches
Innovative Features - 2024-2025 research

DSPy Integration

DSPy Research - Comprehensive research
DSPy Quick Start - Quick start guide
Claude Flow Integration - Integration guide

Project Information

README - Documentation overview
Project README - Project overview
CHANGELOG - Version history
LICENSE - MIT License

Documentation Statistics

Total directories: 20+
Total documentation files: 170+ markdown files
User guides: 12+ comprehensive guides
API references: 3 platform APIs
Code examples: 10+ working examples
Languages covered: Rust, JavaScript/TypeScript, WASM, SQL

Getting Help

Resources

Documentation: This index and linked guides
Examples: ../examples/ directory
API docs: cargo doc --no-deps --open
Benchmarks: cargo bench

Support Channels

GitHub Issues: Report bugs or request features
GitHub Discussions: Ask questions
Pull Requests: Contribute code

Last Updated: 2025-12-25 Version: 0.1.29

13 KiB Raw Blame History