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/INDEX.md
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

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

Quick Starts

WASM Guides

Migration

HNSW Documentation

PostgreSQL Extension

Core Documentation

SparseVec

Zero-Copy Memory

Architecture Documentation

Cloud Architecture

API Reference

Platform APIs

GNN & Graph Documentation

Integration Guides

Performance & Benchmarks

Optimization Guides

Implementation Documentation

Implementation Details

Phase Summaries

Publishing & Deployment

Development

Testing

Research & Advanced Features

Cognitive Frontier

Latent Space

MinCut Research

GNN v2 Research

DSPy Integration

Project Information

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

Last Updated: 2025-12-25 Version: 0.1.29