mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-08-27 09:32:06 +00:00
* chore: gitignore Hailo venvs, .ruvnet-brain scratch dirs, coverage output Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: rvForge ADRs 283-293 + canonical requirements (ADR-283 master, RVM integration 284-293) One canonical RVF to signed platform installers: @ruvector/forge CLI, hosted build service, Tauri RVF Reader, rvm-* backend crates. Derived from the rvForge product directive; requirements.md is the source of truth for the feat/rvf-forge build-out. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: RVForge platform spec (Store/Reader/Publisher/Registry/Enterprise) + naming Adopt RVForge capitalization; publisher CLI is @ruvector/rvforge. Adds marketplace objects, trust levels, review pipeline, security/ countersigning model, licensing, enterprise governance, and platform acceptance test to the canonical requirements. Seeds loop-state.md for the overnight build loop. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: ADR-294 — RVForge platform (store, registry, trust system) Five products (Store/Reader/Publisher/Registry/Enterprise), immutable predecessor-linked releases, four trust levels, review pipeline, countersigning + revocation semantics, licensing, enterprise override. Documents the @ruvector/rvforge naming supersession. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 2 — forge-core crate agent spawned Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: RVForge registry data model v0.1 (content-addressed, predecessor-linked) Wire-format contract for publisher CLI, Reader, and registry: canonical JSON identity rules, Release/PublisherRecord/CapabilityManifest/ WitnessReceipt/Revocation/TransparencyLogEntry objects, local storage layout. Revocation blocks execution, never deletes local RVFs (ADR-294). Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * ci: RVForge 3-OS build matrix for CLI package and rvf-forge-core crate Path-filtered workflow: npm install/build/test for the CLI on ubuntu/windows/macos, cargo test + clippy -D warnings + fmt check for the crate. Tolerates the pending forge->rvforge package rename and skips gracefully while directories are still landing. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: ADR-291 compatibility matrix v1; reader scaffold in flight Machine-readable runtime-profile/packaging/output matrix the CLI vendors; wasm and os-isolation+wasm supported, microvm and rvm-native planned with explicit isolation claims per ADR-285. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge): @ruvector/rvforge CLI — validate/build/verify with local RVF inspection Publisher/build CLI per ADR-283 §4: init, validate (local, inspection- only, never executes RVF content), build (local mode: canonical build manifest + staged bundle + checksums + provenance), submit/status/ download (hosted API client, FORGE_API_URL), verify (checksum + prove- nance recheck). Stable FORGE_E_* error codes, --json unattended mode, 73 jest tests green across 5 suites with synthetic RVF fixture. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — CLI step 1 complete Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * ci: install rvforge CLI standalone (--workspaces=false) Plain npm install inside npm/packages/rvforge resolves the parent npm workspace and fails EBADPLATFORM on platform-pinned siblings (router-darwin-arm64 on linux runners). Verified clean install + 73 tests green locally with the flag. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 6 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvf-forge-core): inspection-only RVF packaging/verification crate Per ADR-283/290/291: container inspection without execution, Ed25519 root-manifest + per-segment hash verification with unsigned-executable- segment rejection, deterministic canonical build manifest (ADR-291 contract fields), provenance records, SHA256 checksum manifests, stable wire error codes mirroring the CLI. 103 unit tests + integration pipeline test, clippy -D warnings and fmt clean. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — core crate step 2 complete Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 7 — packaging+witness agent spawned Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: RVForge Agent Dock spec (D1-D8) — security/control surface Collapsed pill + expanded trust view, 8 agent states, RVForge-owned chrome vs agent content separation (spoofing defense), per-platform placement, capability card, event-threshold noise control, 5s/2-action termination acceptance test. ADR-295 in flight; dock implementation queued behind reader scaffold in loop plan. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — scope widened to full ADR-283..295 implementation Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge-reader): Tauri v2 Reader scaffold + ADR-295 Agent Dock spec Reader (standalone workspace, excluded from root): verify/capability- card/runtime screens as framework-free static UI, runtime selection implementing the FR004 ladder from the vendored compatibility matrix, P6 capability contract rendering with vague-scope rejection, ADR-288 state-capsule layout (encryption stubbed, marked), inspect stubbed pending rvf-forge-core FFI. 39 tests green, cargo check clean, parent workspace unaffected. ADR-295: dock chrome RVForge-owned, agent content strictly separated. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — reader scaffold + ADR-295 landed Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 10 — dock-impl spawned Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 11 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge): embedded/thin packaging, compat enforcement, inventory, witness chains FR001/FR002: embedded mode with cross-target identical-RVF-hash invariant (build fails on divergence), thin-mode signed locators with round-trip verification. ADR-291 compat-matrix enforcement with closest-supported suggestions. Deterministic software inventory (§3.9). Hash-chained witness receipts (receipts.jsonl) on build/verify with broken-chain detection. 137 jest tests green across 9 suites. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — steps 6+7 CLI side complete Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 13 — publisher-verbs spawned Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 14 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge-registry): content-addressed local registry with transparency log ADR-294 MVP: canonical-JSON content addressing (id excludes signatures), typed registry objects, ed25519 release-publish rules (bad-sig/revoked- key/lineage violations typed), trust levels raisable only by registry signature, non-destructive revocation (blocks execution, reads preserved — tested), Merkle transparency log with inclusion proofs + tamper detection, witness receipt chains on publish/revoke/verify. Reuses rvf-forge-core canonical/error patterns. 67 tests, clippy+fmt clean. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — registry crate landed (P2-impl, P4) Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge-reader): ADR-295 Agent Dock — typed trust boundary, states, roster Trust boundary enforced structurally: AgentProvidedStatus (sanitized task text + progress only) composed separately from SystemOwnedStatus (state, trust badge, network, permissions, witness, cost) — agent input cannot reach system fields by construction. Sanitizer strips ANSI/ control chars, caps length, flags system-label mimicry as suspicious. 8-state machine (pause/terminate always one action; quarantine/ capability-denied not agent-exitable), attention-priority roster (approval > denial > error > running), D8 event thresholds, pill + expanded UI with visually distinct system chrome. 90 reader tests green. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — Agent Dock implemented (P5) Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: ADR status updates — 291/295 Implemented, 283/294 Accepted-in-progress Living-plans sync: statuses now reflect what is actually on the branch, with Updated notes naming landed scope and remaining gaps. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 17 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * ci: cover rvforge-registry and rvforge-reader in the RVForge matrix Registry tests/clippy/fmt ride the existing core job; the reader gets its own 3-OS job run inside its standalone workspace directory. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 18 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: acceptance traceability matrix — merge gate for PR #790 Maps every §15/platform/dock criterion to automated evidence or a named DEFERRED blocker (clean-OS installs, notarization, cross-repo rvm runtime). Merge gates on green AUTOMATED rows across 3 OSes. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 19 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge): publisher verbs pack/test/publish with local registry pack: P4 validation (structure, capability specificity with ADR-294 manual-review-trigger flagging, compat, inventory, license), draft Release + CapabilityManifest objects. test: inspection-only subset of the 10 P4 categories with honest 'skipped: requires quarantined runtime' for execution-dependent ones; tampered variants rejected. publish: ed25519-signed content-addressed writes to the registry-model layout (predecessor lineage, transparency log, witness receipt); keygen via node:crypto; key files never logged, world-readable keys refused. 220 jest tests green across 13 suites. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — publisher verbs landed (P1) Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 21 — parity-check spawned Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge-reader): real rvf-forge-core verification + encrypted state capsules Inspect/verify now call rvf-forge-core (inspection-only, verification before any load, witness record per verification appended to the state dir per ADR-284 req 9); capability card derives from real declared capabilities and refuses to render unverified; state capsules encrypted (ChaCha20-Poly1305, per-install key, 0600 perms) with base-RVF lineage binding and mismatch rejection per ADR-288. 113 reader tests green. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — reader FFI landed Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * docs: ADR 284-293 status sync against landed implementation 284/285/286/288/289 -> Accepted with precise landed-scope notes; 287/290/292/293 stay Proposed with honest gap notes (hosted service, rvm runtime — cross-repo). Living-plans discipline: every status now matches the code on this branch. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 23 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 24 — parity in progress, CI 7 green / 0 red Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 25 — witness-viewer spawned Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge): CLI<->Rust registry parity — proven interoperable rvforge-registry-check binary validates any registry dir (content addresses, release rules, lineage, log inclusion, witness chains); scripts/rvforge-parity-check.sh publishes two lineage-linked releases through the real CLI and validates with the Rust crate — PARITY OK. CLI canonical-JSON/id divergences fixed on the CLI side per contract. CI parity job added (ubuntu). Registry 92 tests, CLI suites green. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — parity landed, PARITY OK Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore(rvforge): prepublishOnly gate (build+test) before any npm publish Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 27 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 28 — acceptance snapshot green, CI 6/0/48 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * feat(rvforge-reader): witness viewer — hash-chain verification screen + dock wiring P15.11: loads reader/CLI receipts.jsonl, verifies per-subject content-id + prevReceipt continuity, renders chronological chains with exact broken-at-N indicators; dock witness-status element now reflects real chain state. Entirely system-owned chrome (ADR-295). Tamper/reorder/ empty cases tested. 133 reader tests green. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — witness viewer landed; all workstreams complete Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 30 — awaiting full-green CI (0 failures) Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 31 — CI 12/42/0 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 32 — CI 31/23/0, parity green in CI Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 33 — CI 29/25/0 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * fix(rvf-forge-core): classify rooted paths uniformly across platforms Windows CI failure: '/etc/hostname' has a root but no drive prefix, so is_absolute() is false on Windows and the path took the relative branch with a different rejection message than the test (and Linux) expected. Branch on has_root() instead — any rooted path goes through the containment check on every platform. Refusal behavior unchanged; only classification is now uniform. Linux gate re-verified: 117 tests, clippy, fmt green. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 34 — windows path-classification fix pushed Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 35 — post-fix CI clean, re-running Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 36 — CI 32/22/0, fix verified Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 37 — CI 33/21/0 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state iteration 38 — CI 32/22/0 Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx * chore: loop-state — final verdict, proceeding to merge on documented basis Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01ParP55bZs2iTGEGvpnUecx |
||
|---|---|---|
| .. | ||
| adr | ||
| analysis | ||
| api | ||
| architecture | ||
| benchmarks | ||
| cloud-architecture | ||
| cnn | ||
| code-reviews | ||
| dag | ||
| decisions | ||
| development | ||
| evidence | ||
| examples | ||
| gnn | ||
| guides | ||
| hailo | ||
| hnsw | ||
| hooks | ||
| implementation | ||
| integration | ||
| nervous-system | ||
| optimization | ||
| plans | ||
| postgres | ||
| project-phases | ||
| publishing | ||
| releases | ||
| research | ||
| reviews | ||
| ruvllm | ||
| rvagent | ||
| sdk | ||
| security | ||
| sonic-ct | ||
| sparse-inference | ||
| sql | ||
| testing | ||
| training | ||
| .gitkeep | ||
| .nojekyll | ||
| agi-container.md | ||
| C2-shell-execution-hardening.md | ||
| C8_RESULT_VALIDATION_IMPLEMENTATION.md | ||
| consciousness-api.md | ||
| IMPLEMENTATION-C5.md | ||
| index.html | ||
| INDEX.md | ||
| METAHARNESS-ARCHITECTURE-SUMMARY.md | ||
| metaharness-implementation-plan.md | ||
| moe-routing-optimization-analysis.md | ||
| README.md | ||
| REPO_STRUCTURE.md | ||
| research-openfang.md | ||
RuVector Documentation
Complete documentation for RuVector, the high-performance Rust vector database with global scale capabilities.
📚 Documentation Structure
docs/
├── adr/ # Architecture Decision Records
├── analysis/ # Research & analysis docs
├── api/ # API references (Rust, Node.js, Cypher)
├── architecture/ # System design docs
├── benchmarks/ # Performance benchmarks & results
├── cloud-architecture/ # Cloud deployment guides
├── code-reviews/ # Code review documentation
├── dag/ # DAG implementation
├── development/ # Developer guides
├── examples/ # SQL examples
├── gnn/ # GNN/Graph implementation
├── guides/ # User guides & tutorials
├── hnsw/ # HNSW index documentation
├── hooks/ # Hooks system documentation
├── implementation/ # Implementation details & summaries
├── integration/ # Integration guides
├── nervous-system/ # Nervous system architecture
├── optimization/ # Performance optimization guides
├── plans/ # Implementation plans
├── postgres/ # PostgreSQL extension docs
├── project-phases/ # Development phases
├── publishing/ # NPM publishing guides
├── research/ # Research documentation
├── ruvllm/ # RuVLLM documentation
├── security/ # Security audits & reports
├── sparse-inference/ # Sparse inference docs
├── sql/ # SQL examples
├── testing/ # Testing documentation
└── training/ # Training & LoRA docs
Getting Started
- guides/GETTING_STARTED.md - Getting started guide
- guides/BASIC_TUTORIAL.md - Basic tutorial
- guides/INSTALLATION.md - Installation instructions
- guides/AGENTICDB_QUICKSTART.md - AgenticDB quick start
- guides/wasm-api.md - WebAssembly API documentation
Architecture & Design
- architecture/ - System architecture details
- cloud-architecture/ - Global cloud deployment
- adr/ - Architecture Decision Records
- nervous-system/ - Nervous system architecture
API Reference
- api/RUST_API.md - Rust API reference
- api/NODEJS_API.md - Node.js API reference
- api/CYPHER_REFERENCE.md - Cypher query reference
Performance & Benchmarks
- benchmarks/ - Performance benchmarks & results
- optimization/ - Performance optimization guides
- analysis/ - Research & analysis docs
Security
- security/ - Security audits & reports
Implementation
- implementation/ - Implementation details & summaries
- integration/ - Integration guides
- code-reviews/ - Code review documentation
Specialized Topics
- gnn/ - GNN/Graph implementation
- hnsw/ - HNSW index documentation
- postgres/ - PostgreSQL extension docs
- ruvllm/ - RuVLLM documentation
- training/ - Training & LoRA docs
Development
- development/CONTRIBUTING.md - Contribution guidelines
- development/MIGRATION.md - Migration guide
- testing/ - Testing documentation
- publishing/ - NPM publishing guides
Research
- research/ - Research documentation
- cognitive-frontier/ - Cognitive frontier research
- gnn-v2/ - GNN v2 research
- latent-space/ - HNSW & attention research
- mincut/ - MinCut algorithm research
🚀 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 Architecture Decisions
- Check Migration Guide
For Performance Tuning
- Review Optimization Guide
- Run Benchmarks
- Check Analysis
📊 Documentation Status
| Category | Directory | Status |
|---|---|---|
| Getting Started | guides/ | ✅ Complete |
| Architecture | architecture/, adr/ | ✅ Complete |
| API Reference | api/ | ✅ Complete |
| Performance | benchmarks/, optimization/, analysis/ | ✅ Complete |
| Security | security/ | ✅ Complete |
| Implementation | implementation/, integration/ | ✅ Complete |
| Development | development/, testing/ | ✅ Complete |
| Research | research/ | 📚 Ongoing |
Total Documentation: 460+ documents across 60+ directories
🔗 External Resources
- GitHub Repository: https://github.com/ruvnet/ruvector
- Main README: ../README.md
- Changelog: ../CHANGELOG.md
- License: ../LICENSE
Last Updated: 2026-02-26 | Version: 2.0.4 (core) / 0.1.100 (npm) | Status: Production Ready