Commit graph

2 commits

Author SHA1 Message Date
rUv
69cf4c5304 docs: update guides to match current API surface and versions
- GETTING_STARTED.md: rewrite to cover both ruvector-core (VectorDB) and
  rvf-runtime (RvfStore) APIs, add package registry table, fix SearchQuery
  fields (ef_search not include_vectors), results use .score not .distance
- INSTALLATION.md: update crate version 0.1.0 -> 2.0, fix npm scoped
  package names (@ruvector/*), remove non-existent Docker image, update
  Rust version requirement to 1.80+, fix CLI docs to match actual subcommands
- BASIC_TUTORIAL.md: fix SearchQuery.include_vectors -> ef_search, fix
  result.distance -> result.score, fix HnswConfig/QuantizationConfig field
  access patterns (options.hnsw -> options.hnsw_config, wrap in Some())
- ADVANCED_FEATURES.md: same field name fixes, fix QuantizationConfig
  wrapping in Some(), remove references to non-existent mmap_vectors field
- docs/README.md: update version to 2.0.4/0.1.100, update date

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-02-26 16:05:29 +00:00
rUv
6a0ce6a637 docs: Reorganize documentation and add postgres README
ruvector-postgres:
- Add comprehensive README.md with features, comparison, tutorials
- Create docs/implementation/ and docs/guides/ subdirectories
- Move implementation summaries to organized locations

Root docs reorganization:
- Move HNSW docs to docs/hnsw/
- Move postgres docs to docs/postgres/
- Move zero-copy docs to docs/postgres/zero-copy/
- Move guides to docs/guides/
- Move architecture to docs/architecture/
- Move benchmarks docs to benchmarks/docs/
- Move benchmark source to benchmarks/src/

Cleanup:
- Remove duplicate install/ from root (now in crates/ruvector-postgres/install/)
- Remove stale benchmark results
- Remove duplicate binary files

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 16:45:44 +00:00
Renamed from docs/guide/GETTING_STARTED.md (Browse further)