vrr/ruvector
2
0
Fork 0
mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-23 12:55:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 19
2592 commits 175 branches 48 tags 1,015 MiB
Commit graph

4 commits

Author SHA1 Message Date
rUv
c31d1de2b7 fix(brain): defer sparsifier build on startup for large graphs 
Sparsifier build on 1M+ edges exceeds Cloud Run's 4-min startup probe.
Skip on startup for graphs > 100K edges, defer to rebuild_graph job.

Co-Authored-By: claude-flow <ruv@ruv.net>
 2026-03-24 12:29:52 +00:00
rUv
eda7df86b6 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
Reuven
d3229d84d5 docs: reorganize into subfolders 
- Create new directories: security/, code-reviews/, analysis/
- Move benchmark files to benchmarks/
- Move security audit files to security/
- Move analysis/research files to analysis/
- Move code review files to code-reviews/
- Move implementation files to implementation/
- Move integration files to integration/
- Move training/LoRA files to training/
- Move architecture files to architecture/
- Move optimization guides to optimization/
- Update INDEX.md with new structure
- Update README.md with new structure
- Update REPO_STRUCTURE.md with new structure

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
 2026-01-21 23:43:50 -05:00
Claude
22e9e48d37 Clean up repository structure and organize documentation 
## Repository Cleanup

### Root Directory
- ✅ Removed duplicate .implementation-summary.md
- ✅ Removed test binary (test_cosine)
- ✅ Removed PHASE3_COMPLETE.txt
- ✅ Removed duplicate IMPLEMENTATION_SUMMARY.md from root
- ✅ Clean root with only 8 essential files

### Documentation Organization
Created organized docs/ structure with clear categories:

**New Structure:**
- docs/getting-started/ (7 files) - Quick starts and tutorials
- docs/development/ (3 files) - Contributing and development guides
- docs/testing/ (2 files) - Testing documentation
- docs/project-phases/ (9 files) - Historical project phases
- docs/api/ (existing) - API documentation
- docs/architecture/ (existing) - System architecture
- docs/cloud-architecture/ (existing) - Global deployment
- docs/guide/ (existing) - User guides
- docs/benchmarks/ (existing) - Benchmarking
- docs/optimization/ (existing) - Performance optimization

**Files Moved:**
FROM ROOT:
- AGENTICDB_QUICKSTART.md → docs/getting-started/
- OPTIMIZATION_QUICK_START.md → docs/getting-started/
- PHASE5_COMPLETE.md → docs/project-phases/

FROM DOCS ROOT:
- AGENTICDB_API.md → docs/getting-started/
- advanced-features.md → docs/getting-started/
- wasm-api.md → docs/getting-started/
- wasm-build-guide.md → docs/getting-started/
- quick-fix-guide.md → docs/getting-started/
- CONTRIBUTING.md → docs/development/
- MIGRATION.md → docs/development/
- FIXING_COMPILATION_ERRORS.md → docs/development/
- TDD_TEST_SUITE_SUMMARY.md → docs/testing/
- integration-testing-report.md → docs/testing/
- PHASE*.md (8 files) → docs/project-phases/
- phase*.md (3 files) → docs/project-phases/

### Documentation Created
- docs/README.md - Complete documentation index with navigation
- docs/.gitkeep - Structure explanation

### Updated References
- README.md - Updated all documentation links to new locations
- Added Documentation Index link
- Added Contributing Guidelines section with multiple links

### .gitignore Enhanced
- Added rules for test files and binaries
- Added rules for hidden duplicates
- Added rules for temporary files
- Added documentation build artifacts

## Results

**Before:**
- Root: 12+ files including tests, duplicates
- Docs: Flat structure with 30+ files
- Difficult to navigate

**After:**
- Root: 8 essential files only ✅
- Docs: 42 files in 10 organized categories ✅
- Clear navigation with README.md ✅
- No duplicates or test files ✅

**File Organization:**
- Total documentation: 42 markdown files
- Properly categorized by purpose
- Easy to find and navigate
- Professional structure

Repository is now clean, organized, and production-ready! 🎉
 2025-11-20 19:50:03 +00:00