diff --git a/.github/workflows/trigger-docs-update.yml b/.github/workflows/trigger-docs-update.yml index ffc883f..8d69d8f 100644 --- a/.github/workflows/trigger-docs-update.yml +++ b/.github/workflows/trigger-docs-update.yml @@ -2,9 +2,12 @@ # Trigger Docs Update Workflow # ============================================================================= # -# Sends a repository_dispatch event to the agentfront-docs repo when: -# 1. A GitHub Release is published (for stable releases) -# 2. A PR is merged to a release/* branch (for docs changes before release) +# Sends a repository_dispatch event to the agentfront-docs repo when the +# Publish Release workflow completes successfully. +# +# NOTE: This workflow uses workflow_run trigger instead of release:published +# because releases created with GITHUB_TOKEN don't trigger other workflows +# (GitHub Actions limitation to prevent infinite loops). # # SETUP REQUIRED: # Create a repository secret named DOCS_SYNC_TOKEN: @@ -17,10 +20,9 @@ name: Trigger Docs Update on: - release: - types: [published] - pull_request: - types: [closed] + workflow_run: + workflows: ["Publish Release"] + types: [completed] permissions: contents: read @@ -29,100 +31,51 @@ env: REPO_NAME: vectoriadb jobs: - trigger-on-release: - if: github.event_name == 'release' + trigger-docs-sync: + # Only run if publish-release succeeded + if: github.event.workflow_run.conclusion == 'success' runs-on: ubuntu-latest steps: - - name: Trigger docs sync + - name: Get release info + id: release uses: actions/github-script@v7 with: - github-token: ${{ secrets.DOCS_SYNC_TOKEN }} script: | - const repoName = process.env.REPO_NAME; - const tag = context.payload.release.tag_name; - const sha = context.sha; + // Get the most recent release + const { data: releases } = await github.rest.repos.listReleases({ + owner: context.repo.owner, + repo: context.repo.repo, + per_page: 1 + }); + + if (releases.length === 0) { + core.setFailed('No releases found'); + return; + } + + const release = releases[0]; + const tag = release.tag_name; // Extract version minor from tag (e.g., "v2.1.0" -> "2.1") const versionMatch = tag.match(/^v?(\d+)\.(\d+)/); const versionMinor = versionMatch ? `${versionMatch[1]}.${versionMatch[2]}` : null; - console.log(`Triggering docs sync for ${repoName}`); - console.log(` Tag: ${tag}`); - console.log(` SHA: ${sha}`); - console.log(` Version minor: ${versionMinor}`); - - try { - await github.rest.repos.createDispatchEvent({ - owner: 'agentfront', - repo: 'docs', - event_type: 'sync-docs', - client_payload: { - repo: repoName, - sha: sha, - tag: tag, - version_minor: versionMinor - } - }); - console.log(`Successfully triggered docs sync for ${tag}`); - } catch (error) { - console.error(`Failed to trigger docs sync: ${error.message}`); - if (error.status === 404) { - console.error('Check that DOCS_SYNC_TOKEN has access to agentfront/docs'); - } else if (error.status === 401) { - console.error('Check that DOCS_SYNC_TOKEN secret is set correctly'); - } - throw error; - } + // Get the commit SHA for the tag + const { data: ref } = await github.rest.git.getRef({ + owner: context.repo.owner, + repo: context.repo.repo, + ref: `tags/${tag}` + }); - - name: Summary - run: | - echo "## Docs Sync Triggered (Release)" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - echo "- **Repository:** ${{ env.REPO_NAME }}" >> $GITHUB_STEP_SUMMARY - echo "- **Tag:** ${{ github.event.release.tag_name }}" >> $GITHUB_STEP_SUMMARY - echo "- **SHA:** ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - echo "The [agentfront-docs](https://github.com/agentfront/docs) repository will sync the documentation shortly." >> $GITHUB_STEP_SUMMARY + const sha = ref.object.sha; - trigger-on-pr-merge: - if: > - github.event_name == 'pull_request' && - github.event.pull_request.merged == true && - startsWith(github.event.pull_request.base.ref, 'release/') - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 + core.setOutput('tag', tag); + core.setOutput('sha', sha); + core.setOutput('version_minor', versionMinor); - - name: Determine diff base - id: diff_base - shell: bash - run: | - set -euo pipefail - - BRANCH="${{ github.event.pull_request.base.ref }}" - - # Check for .release-docs-base marker file - if [ -f ".release-docs-base" ]; then - DIFF_BASE=$(cat .release-docs-base) - echo "Using diff base from .release-docs-base: $DIFF_BASE" - else - # Fallback to branch creation point - DIFF_BASE=$(git merge-base origin/main "origin/$BRANCH" 2>/dev/null || echo "") - if [ -z "$DIFF_BASE" ]; then - DIFF_BASE="HEAD~1" - fi - echo "Using fallback diff base: $DIFF_BASE" - fi - - echo "diff_base=$DIFF_BASE" >> "$GITHUB_OUTPUT" - - # Extract version minor from branch (e.g., "release/2.1.x" -> "2.1") - VERSION_MINOR=$(echo "$BRANCH" | sed 's/release\/\([0-9]*\.[0-9]*\).*/\1/') - echo "version_minor=$VERSION_MINOR" >> "$GITHUB_OUTPUT" - echo "Version minor: $VERSION_MINOR" + console.log(`Release: ${tag}`); + console.log(`SHA: ${sha}`); + console.log(`Version minor: ${versionMinor}`); - name: Trigger docs sync uses: actions/github-script@v7 @@ -130,19 +83,14 @@ jobs: github-token: ${{ secrets.DOCS_SYNC_TOKEN }} script: | const repoName = process.env.REPO_NAME; - const branch = '${{ github.event.pull_request.base.ref }}'; - const sha = context.sha; - const diffBase = '${{ steps.diff_base.outputs.diff_base }}'; - const versionMinor = '${{ steps.diff_base.outputs.version_minor }}'; - const prNumber = context.payload.pull_request.number; - const prTitle = context.payload.pull_request.title; + const tag = '${{ steps.release.outputs.tag }}'; + const sha = '${{ steps.release.outputs.sha }}'; + const versionMinor = '${{ steps.release.outputs.version_minor }}'; console.log(`Triggering docs sync for ${repoName}`); - console.log(` Branch: ${branch}`); + console.log(` Tag: ${tag}`); console.log(` SHA: ${sha}`); - console.log(` Diff base: ${diffBase}`); console.log(` Version minor: ${versionMinor}`); - console.log(` PR: #${prNumber} - ${prTitle}`); try { await github.rest.repos.createDispatchEvent({ @@ -152,14 +100,11 @@ jobs: client_payload: { repo: repoName, sha: sha, - branch: branch, - diff_base: diffBase, - version_minor: versionMinor, - pr_number: prNumber, - pr_title: prTitle + tag: tag, + version_minor: versionMinor } }); - console.log(`Successfully triggered docs sync for PR #${prNumber}`); + console.log(`Successfully triggered docs sync for ${tag}`); } catch (error) { console.error(`Failed to trigger docs sync: ${error.message}`); if (error.status === 404) { @@ -167,18 +112,16 @@ jobs: } else if (error.status === 401) { console.error('Check that DOCS_SYNC_TOKEN secret is set correctly'); } - // Don't fail the workflow for docs sync issues - console.log('Continuing despite docs sync failure'); + throw error; } - name: Summary run: | - echo "## Docs Sync Triggered (PR Merge)" >> $GITHUB_STEP_SUMMARY + echo "## Docs Sync Triggered" >> $GITHUB_STEP_SUMMARY echo "" >> $GITHUB_STEP_SUMMARY echo "- **Repository:** ${{ env.REPO_NAME }}" >> $GITHUB_STEP_SUMMARY - echo "- **Branch:** ${{ github.event.pull_request.base.ref }}" >> $GITHUB_STEP_SUMMARY - echo "- **PR:** #${{ github.event.pull_request.number }}" >> $GITHUB_STEP_SUMMARY - echo "- **SHA:** ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY - echo "- **Diff base:** ${{ steps.diff_base.outputs.diff_base }}" >> $GITHUB_STEP_SUMMARY + echo "- **Tag:** ${{ steps.release.outputs.tag }}" >> $GITHUB_STEP_SUMMARY + echo "- **SHA:** ${{ steps.release.outputs.sha }}" >> $GITHUB_STEP_SUMMARY + echo "- **Version:** ${{ steps.release.outputs.version_minor }}" >> $GITHUB_STEP_SUMMARY echo "" >> $GITHUB_STEP_SUMMARY echo "The [agentfront-docs](https://github.com/agentfront/docs) repository will sync the documentation shortly." >> $GITHUB_STEP_SUMMARY diff --git a/README.md b/README.md index 64822a9..aef0637 100644 --- a/README.md +++ b/README.md @@ -4,101 +4,69 @@ [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/) -> A lightweight, production-ready in-memory vector database for semantic search in JavaScript/TypeScript - -VectoriaDB is a fast, minimal-dependency vector database designed for in-memory semantic search. Powered by [transformers.js](https://github.com/xenova/transformers.js), it's perfect for applications that need to quickly search through documents, tools, or any text-based data using natural language queries. +> Lightweight, in-memory vector database for semantic search in JavaScript/TypeScript ## Features -- **Fast**: In-memory storage with optimized HNSW indexing for O(log n) search -- **Lightweight**: Minimal dependencies, small footprint -- **Semantic Search**: Natural language queries using state-of-the-art embeddings -- **Type-Safe**: Full TypeScript support with generics -- **Batch Operations**: Efficient bulk insert and search -- **Flexible Filtering**: Custom metadata filtering with type safety -- **Scalable**: HNSW index for 100k+ documents with sub-millisecond search -- **Persistent**: File & Redis adapters for caching across restarts -- **Smart Updates**: Incremental updates without re-embedding (instant metadata updates) -- **Production-Ready Error Handling**: Typed error classes with specific error codes +- **Fast** - HNSW indexing for O(log n) search on 100k+ documents +- **Lightweight** - Minimal dependencies, small footprint +- **Type-Safe** - Full TypeScript support with generics +- **Flexible** - Custom metadata filtering with batch operations +- **Persistent** - File & Redis adapters for caching across restarts +- **Zero-Dep Option** - TF-IDF mode for simpler deployments ## Installation ```bash npm install vectoriadb -# or -yarn add vectoriadb -# or -pnpm add vectoriadb ``` -**Requirements:** - -- Node.js 18+ (for transformers.js compatibility) -- TypeScript 5.0+ (if using TypeScript) +Requires Node.js 18+. ## Quick Start ```typescript import { VectoriaDB } from 'vectoriadb'; -// Create and initialize the database const db = new VectoriaDB(); await db.initialize(); -// Add documents -await db.add('doc-1', 'How to create a user account', { - id: 'doc-1', - category: 'auth', - author: 'Alice', -}); +// Add documents with metadata +await db.add('doc-1', 'How to create a user account', { category: 'auth' }); +await db.add('doc-2', 'Send email notifications', { category: 'notifications' }); -await db.add('doc-2', 'Send email notifications to users', { - id: 'doc-2', - category: 'notifications', - author: 'Bob', -}); - -// Search +// Semantic search const results = await db.search('creating new accounts'); -console.log(results[0].metadata); // { id: 'doc-1', category: 'auth', ... } console.log(results[0].score); // 0.87 ``` ## Documentation -| Guide | Description | -|-------|-------------| -| [Overview](./docs/overview.md) | Installation, quick start, configuration | -| [Indexing](./docs/guides/indexing.md) | Adding and updating documents | -| [Search](./docs/guides/search.md) | Querying with filters and thresholds | -| [Persistence](./docs/guides/persistence.md) | File and Redis storage adapters | -| [HNSW](./docs/guides/hnsw.md) | Scaling to 100k+ documents | -| [TF-IDF](./docs/guides/tfidf.md) | Zero-dependency alternative | -| [Tool Discovery](./docs/guides/tool-discovery.md) | Complete tool indexing example | -| [Error Handling](./docs/reference/errors.md) | Typed error classes | - -See also the [detailed API documentation](./libs/vectoriadb/README.md). +| Topic | Link | +|-------|------| +| Get Started | [Welcome](https://agentfront.dev/docs/vectoriadb/get-started/welcome) | +| Installation | [Setup Guide](https://agentfront.dev/docs/vectoriadb/get-started/installation) | +| Quickstart | [First Steps](https://agentfront.dev/docs/vectoriadb/get-started/quickstart) | +| Indexing | [Core Guide](https://agentfront.dev/docs/vectoriadb/guides/core/indexing-basics) | +| Search | [Search Guide](https://agentfront.dev/docs/vectoriadb/guides/search/basic-search) | +| Storage | [Persistence](https://agentfront.dev/docs/vectoriadb/guides/storage/overview) | +| Scaling | [HNSW Overview](https://agentfront.dev/docs/vectoriadb/guides/scaling/hnsw-overview) | +| TF-IDF | [Alternative](https://agentfront.dev/docs/vectoriadb/guides/alternatives/tfidf) | +| Production | [Deployment](https://agentfront.dev/docs/vectoriadb/deployment/production-config) | +| API Reference | [Full API](https://agentfront.dev/docs/vectoriadb/api-reference/overview) | ## Development ```bash -# Install dependencies -yarn install - -# Run tests -npx nx test vectoriadb - -# Build library -npx nx build vectoriadb - -# Run demo -npx nx serve vectoriadb-demo +yarn install # Install dependencies +npx nx test vectoriadb # Run tests +npx nx build vectoriadb # Build library ``` ## License Apache-2.0 -## Credits +--- Built with [transformers.js](https://github.com/xenova/transformers.js) by Xenova. diff --git a/docs/docs.json b/docs/docs.json index 37272de..8af2808 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -55,9 +55,9 @@ { "group": "Get Started", "pages": [ - "get-started/welcome", - "get-started/installation", - "get-started/quickstart" + "docs/vectoriadb/get-started/welcome", + "docs/vectoriadb/get-started/installation", + "docs/vectoriadb/get-started/quickstart" ] }, { @@ -67,40 +67,40 @@ "group": "Document Operations", "icon": "database", "pages": [ - "guides/core/indexing-basics", - "guides/core/adding-documents", - "guides/core/updating-documents", - "guides/core/removing-documents" + "docs/vectoriadb/guides/core/indexing-basics", + "docs/vectoriadb/guides/core/adding-documents", + "docs/vectoriadb/guides/core/updating-documents", + "docs/vectoriadb/guides/core/removing-documents" ] }, { "group": "Search", "icon": "magnifying-glass", "pages": [ - "guides/search/basic-search", - "guides/search/filtering", - "guides/search/similarity-thresholds", - "guides/search/performance" + "docs/vectoriadb/guides/search/basic-search", + "docs/vectoriadb/guides/search/filtering", + "docs/vectoriadb/guides/search/similarity-thresholds", + "docs/vectoriadb/guides/search/performance" ] }, { "group": "Storage", "icon": "floppy-disk", "pages": [ - "guides/storage/overview", - "guides/storage/file-adapter", - "guides/storage/redis-adapter", - "guides/storage/memory-adapter", - "guides/storage/cache-invalidation" + "docs/vectoriadb/guides/storage/overview", + "docs/vectoriadb/guides/storage/file-adapter", + "docs/vectoriadb/guides/storage/redis-adapter", + "docs/vectoriadb/guides/storage/memory-adapter", + "docs/vectoriadb/guides/storage/cache-invalidation" ] }, { "group": "Scaling", "icon": "chart-network", "pages": [ - "guides/scaling/hnsw-overview", - "guides/scaling/hnsw-configuration", - "guides/scaling/hnsw-tuning" + "docs/vectoriadb/guides/scaling/hnsw-overview", + "docs/vectoriadb/guides/scaling/hnsw-configuration", + "docs/vectoriadb/guides/scaling/hnsw-tuning" ] } ] @@ -108,48 +108,48 @@ { "group": "Alternatives", "pages": [ - "guides/alternatives/tfidf" + "docs/vectoriadb/guides/alternatives/tfidf" ] }, { "group": "Use Cases", "pages": [ - "guides/use-cases/tool-discovery" + "docs/vectoriadb/guides/use-cases/tool-discovery" ] }, { "group": "Deployment", "icon": "rocket", "pages": [ - "deployment/production-config", - "deployment/docker", - "deployment/environment-variables", - "deployment/health-monitoring" + "docs/vectoriadb/deployment/production-config", + "docs/vectoriadb/deployment/docker", + "docs/vectoriadb/deployment/environment-variables", + "docs/vectoriadb/deployment/health-monitoring" ] }, { "group": "Integrations", "icon": "puzzle-piece", "pages": [ - "integrations/overview", - "integrations/frontmcp", - "integrations/enclave", - "integrations/express", - "integrations/nextjs" + "docs/vectoriadb/integrations/overview", + "docs/vectoriadb/integrations/frontmcp", + "docs/vectoriadb/integrations/enclave", + "docs/vectoriadb/integrations/express", + "docs/vectoriadb/integrations/nextjs" ] }, { "group": "Troubleshooting", "icon": "wrench", "pages": [ - "troubleshooting/faq", - "troubleshooting/common-errors" + "docs/vectoriadb/troubleshooting/faq", + "docs/vectoriadb/troubleshooting/common-errors" ] }, { "group": "Updates", "pages": [ - "updates" + "docs/vectoriadb/updates" ] } ] @@ -160,55 +160,55 @@ { "group": "Overview", "pages": [ - "api-reference/overview" + "docs/vectoriadb/api-reference/overview" ] }, { "group": "VectoriaDB", "icon": "database", "pages": [ - "api-reference/vectoriadb/constructor", - "api-reference/vectoriadb/initialize", - "api-reference/vectoriadb/add", - "api-reference/vectoriadb/search", - "api-reference/vectoriadb/update", - "api-reference/vectoriadb/remove", - "api-reference/vectoriadb/query-methods", - "api-reference/vectoriadb/storage-methods" + "docs/vectoriadb/api-reference/vectoriadb/constructor", + "docs/vectoriadb/api-reference/vectoriadb/initialize", + "docs/vectoriadb/api-reference/vectoriadb/add", + "docs/vectoriadb/api-reference/vectoriadb/search", + "docs/vectoriadb/api-reference/vectoriadb/update", + "docs/vectoriadb/api-reference/vectoriadb/remove", + "docs/vectoriadb/api-reference/vectoriadb/query-methods", + "docs/vectoriadb/api-reference/vectoriadb/storage-methods" ] }, { "group": "TFIDFVectoria", "icon": "text", "pages": [ - "api-reference/tfidf-vectoria/constructor", - "api-reference/tfidf-vectoria/methods" + "docs/vectoriadb/api-reference/tfidf-vectoria/constructor", + "docs/vectoriadb/api-reference/tfidf-vectoria/methods" ] }, { "group": "Storage Adapters", "icon": "floppy-disk", "pages": [ - "api-reference/storage-adapters/file-adapter", - "api-reference/storage-adapters/redis-adapter", - "api-reference/storage-adapters/memory-adapter" + "docs/vectoriadb/api-reference/storage-adapters/file-adapter", + "docs/vectoriadb/api-reference/storage-adapters/redis-adapter", + "docs/vectoriadb/api-reference/storage-adapters/memory-adapter" ] }, { "group": "Interfaces", "icon": "code", "pages": [ - "api-reference/interfaces/config", - "api-reference/interfaces/documents", - "api-reference/interfaces/search", - "api-reference/interfaces/storage" + "docs/vectoriadb/api-reference/interfaces/config", + "docs/vectoriadb/api-reference/interfaces/documents", + "docs/vectoriadb/api-reference/interfaces/search", + "docs/vectoriadb/api-reference/interfaces/storage" ] }, { "group": "Errors", "icon": "triangle-exclamation", "pages": [ - "api-reference/errors" + "docs/vectoriadb/api-reference/errors" ] } ] diff --git a/docs/api-reference/errors.mdx b/docs/vectoriadb/api-reference/errors.mdx similarity index 97% rename from docs/api-reference/errors.mdx rename to docs/vectoriadb/api-reference/errors.mdx index 14886f1..a7d6be9 100644 --- a/docs/api-reference/errors.mdx +++ b/docs/vectoriadb/api-reference/errors.mdx @@ -211,10 +211,10 @@ try { ## Related - + Error solutions - + Frequently asked questions diff --git a/docs/api-reference/interfaces/config.mdx b/docs/vectoriadb/api-reference/interfaces/config.mdx similarity index 90% rename from docs/api-reference/interfaces/config.mdx rename to docs/vectoriadb/api-reference/interfaces/config.mdx index 97a248f..c63b8cc 100644 --- a/docs/api-reference/interfaces/config.mdx +++ b/docs/vectoriadb/api-reference/interfaces/config.mdx @@ -159,13 +159,13 @@ interface StorageAdapterConfig { ## Related - + Using config - + Document interfaces - + Search interfaces diff --git a/docs/api-reference/interfaces/documents.mdx b/docs/vectoriadb/api-reference/interfaces/documents.mdx similarity index 89% rename from docs/api-reference/interfaces/documents.mdx rename to docs/vectoriadb/api-reference/interfaces/documents.mdx index ed5bedc..ee8ad64 100644 --- a/docs/api-reference/interfaces/documents.mdx +++ b/docs/vectoriadb/api-reference/interfaces/documents.mdx @@ -136,13 +136,13 @@ results[0].metadata.category; // string ## Related - + Config interfaces - + Search interfaces - + Adding documents diff --git a/docs/api-reference/interfaces/search.mdx b/docs/vectoriadb/api-reference/interfaces/search.mdx similarity index 89% rename from docs/api-reference/interfaces/search.mdx rename to docs/vectoriadb/api-reference/interfaces/search.mdx index c95c964..f3d98a2 100644 --- a/docs/api-reference/interfaces/search.mdx +++ b/docs/vectoriadb/api-reference/interfaces/search.mdx @@ -153,13 +153,13 @@ console.log({ ## Related - + Search method - + Document interfaces - + Config interfaces diff --git a/docs/api-reference/interfaces/storage.mdx b/docs/vectoriadb/api-reference/interfaces/storage.mdx similarity index 88% rename from docs/api-reference/interfaces/storage.mdx rename to docs/vectoriadb/api-reference/interfaces/storage.mdx index cbefeee..995d4b8 100644 --- a/docs/api-reference/interfaces/storage.mdx +++ b/docs/vectoriadb/api-reference/interfaces/storage.mdx @@ -131,13 +131,13 @@ class CustomStorageAdapter ## Related - + File storage - + Redis storage - + Storage guide diff --git a/docs/api-reference/overview.mdx b/docs/vectoriadb/api-reference/overview.mdx similarity index 69% rename from docs/api-reference/overview.mdx rename to docs/vectoriadb/api-reference/overview.mdx index 6b6754a..a6ac4a2 100644 --- a/docs/api-reference/overview.mdx +++ b/docs/vectoriadb/api-reference/overview.mdx @@ -9,10 +9,10 @@ Welcome to the VectoriaDB API reference. This section documents all public class ## Main Classes - + The main vector database class for semantic search - + Zero-dependency TF-IDF variant for keyword search @@ -20,13 +20,13 @@ Welcome to the VectoriaDB API reference. This section documents all public class ## Storage Adapters - + Persist to local disk - + Distributed Redis cache - + In-memory (default) @@ -34,23 +34,23 @@ Welcome to the VectoriaDB API reference. This section documents all public class ## Interfaces - + VectoriaConfig and related options - + DocumentMetadata and DocumentEmbedding - + SearchOptions and SearchResult - + Storage adapter interfaces ## Error Classes - + All VectoriaDB error types with codes and handling examples diff --git a/docs/api-reference/storage-adapters/file-adapter.mdx b/docs/vectoriadb/api-reference/storage-adapters/file-adapter.mdx similarity index 83% rename from docs/api-reference/storage-adapters/file-adapter.mdx rename to docs/vectoriadb/api-reference/storage-adapters/file-adapter.mdx index 1299e7b..bfd1a17 100644 --- a/docs/api-reference/storage-adapters/file-adapter.mdx +++ b/docs/vectoriadb/api-reference/storage-adapters/file-adapter.mdx @@ -71,13 +71,13 @@ The adapter includes path traversal protection: ## Related - + Redis storage - + Memory storage - + File adapter guide diff --git a/docs/api-reference/storage-adapters/memory-adapter.mdx b/docs/vectoriadb/api-reference/storage-adapters/memory-adapter.mdx similarity index 81% rename from docs/api-reference/storage-adapters/memory-adapter.mdx rename to docs/vectoriadb/api-reference/storage-adapters/memory-adapter.mdx index db86aef..bf06cc1 100644 --- a/docs/api-reference/storage-adapters/memory-adapter.mdx +++ b/docs/vectoriadb/api-reference/storage-adapters/memory-adapter.mdx @@ -63,13 +63,13 @@ const db = new VectoriaDB(); ## Related - + File storage - + Redis storage - + Memory adapter guide diff --git a/docs/api-reference/storage-adapters/redis-adapter.mdx b/docs/vectoriadb/api-reference/storage-adapters/redis-adapter.mdx similarity index 86% rename from docs/api-reference/storage-adapters/redis-adapter.mdx rename to docs/vectoriadb/api-reference/storage-adapters/redis-adapter.mdx index 66f78b9..979271c 100644 --- a/docs/api-reference/storage-adapters/redis-adapter.mdx +++ b/docs/vectoriadb/api-reference/storage-adapters/redis-adapter.mdx @@ -88,13 +88,13 @@ The adapter includes command injection protection: ## Related - + File storage - + Memory storage - + Redis adapter guide diff --git a/docs/api-reference/tfidf-vectoria/constructor.mdx b/docs/vectoriadb/api-reference/tfidf-vectoria/constructor.mdx similarity index 88% rename from docs/api-reference/tfidf-vectoria/constructor.mdx rename to docs/vectoriadb/api-reference/tfidf-vectoria/constructor.mdx index 5370930..eb4d1fe 100644 --- a/docs/api-reference/tfidf-vectoria/constructor.mdx +++ b/docs/vectoriadb/api-reference/tfidf-vectoria/constructor.mdx @@ -64,10 +64,10 @@ Use TFIDFVectoria when: ## Related - + All methods - + Usage guide diff --git a/docs/api-reference/tfidf-vectoria/methods.mdx b/docs/vectoriadb/api-reference/tfidf-vectoria/methods.mdx similarity index 93% rename from docs/api-reference/tfidf-vectoria/methods.mdx rename to docs/vectoriadb/api-reference/tfidf-vectoria/methods.mdx index d3f4cf5..40e33c9 100644 --- a/docs/api-reference/tfidf-vectoria/methods.mdx +++ b/docs/vectoriadb/api-reference/tfidf-vectoria/methods.mdx @@ -190,10 +190,10 @@ const results = toolSearch.search('create account'); ## Related - + Create instance - + Usage guide diff --git a/docs/api-reference/vectoriadb/add.mdx b/docs/vectoriadb/api-reference/vectoriadb/add.mdx similarity index 90% rename from docs/api-reference/vectoriadb/add.mdx rename to docs/vectoriadb/api-reference/vectoriadb/add.mdx index 7c32c10..bae2e6a 100644 --- a/docs/api-reference/vectoriadb/add.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/add.mdx @@ -106,13 +106,13 @@ await db.addMany([ ## Related - + Query documents - + Update documents - + Remove documents diff --git a/docs/api-reference/vectoriadb/constructor.mdx b/docs/vectoriadb/api-reference/vectoriadb/constructor.mdx similarity index 91% rename from docs/api-reference/vectoriadb/constructor.mdx rename to docs/vectoriadb/api-reference/vectoriadb/constructor.mdx index f4cdea7..97f97c4 100644 --- a/docs/api-reference/vectoriadb/constructor.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/constructor.mdx @@ -131,13 +131,13 @@ Your custom interface must extend `DocumentMetadata` and include an `id` field. ## Related - + Initialize the database - + Full config interface - + Persistence options diff --git a/docs/api-reference/vectoriadb/initialize.mdx b/docs/vectoriadb/api-reference/vectoriadb/initialize.mdx similarity index 87% rename from docs/api-reference/vectoriadb/initialize.mdx rename to docs/vectoriadb/api-reference/vectoriadb/initialize.mdx index 5f512ba..10604dd 100644 --- a/docs/api-reference/vectoriadb/initialize.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/initialize.mdx @@ -87,13 +87,13 @@ async function startupVectoriaDB() { ## Related - + Create instance - + Add documents - + Storage operations diff --git a/docs/api-reference/vectoriadb/query-methods.mdx b/docs/vectoriadb/api-reference/vectoriadb/query-methods.mdx similarity index 91% rename from docs/api-reference/vectoriadb/query-methods.mdx rename to docs/vectoriadb/api-reference/vectoriadb/query-methods.mdx index a735319..8dacc06 100644 --- a/docs/api-reference/vectoriadb/query-methods.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/query-methods.mdx @@ -219,13 +219,13 @@ console.log({ ## Related - + Semantic search - + Add documents - + Document interfaces diff --git a/docs/api-reference/vectoriadb/remove.mdx b/docs/vectoriadb/api-reference/vectoriadb/remove.mdx similarity index 87% rename from docs/api-reference/vectoriadb/remove.mdx rename to docs/vectoriadb/api-reference/vectoriadb/remove.mdx index 15d9144..3e4f399 100644 --- a/docs/api-reference/vectoriadb/remove.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/remove.mdx @@ -121,13 +121,13 @@ await db.saveToStorage(); ## Related - + Add documents - + Update documents - + Clear storage diff --git a/docs/api-reference/vectoriadb/search.mdx b/docs/vectoriadb/api-reference/vectoriadb/search.mdx similarity index 90% rename from docs/api-reference/vectoriadb/search.mdx rename to docs/vectoriadb/api-reference/vectoriadb/search.mdx index 40305a2..feddc42 100644 --- a/docs/api-reference/vectoriadb/search.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/search.mdx @@ -107,13 +107,13 @@ Enable HNSW for datasets > 10,000 documents. ## Related - + Add documents - + Non-semantic filtering - + Search interface diff --git a/docs/api-reference/vectoriadb/storage-methods.mdx b/docs/vectoriadb/api-reference/vectoriadb/storage-methods.mdx similarity index 88% rename from docs/api-reference/vectoriadb/storage-methods.mdx rename to docs/vectoriadb/api-reference/vectoriadb/storage-methods.mdx index 5b06d36..2386538 100644 --- a/docs/api-reference/vectoriadb/storage-methods.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/storage-methods.mdx @@ -151,13 +151,13 @@ try { ## Related - + File storage - + Redis storage - + Storage guide diff --git a/docs/api-reference/vectoriadb/update.mdx b/docs/vectoriadb/api-reference/vectoriadb/update.mdx similarity index 91% rename from docs/api-reference/vectoriadb/update.mdx rename to docs/vectoriadb/api-reference/vectoriadb/update.mdx index f9bebf7..a29ebf2 100644 --- a/docs/api-reference/vectoriadb/update.mdx +++ b/docs/vectoriadb/api-reference/vectoriadb/update.mdx @@ -141,13 +141,13 @@ console.log(`Updated: ${result.updated}, Re-embedded: ${result.reembedded}`); ## Related - + Add documents - + Remove documents - + Search documents diff --git a/docs/deployment/docker.mdx b/docs/vectoriadb/deployment/docker.mdx similarity index 93% rename from docs/deployment/docker.mdx rename to docs/vectoriadb/deployment/docker.mdx index f4313ef..191ad04 100644 --- a/docs/deployment/docker.mdx +++ b/docs/vectoriadb/deployment/docker.mdx @@ -203,13 +203,13 @@ spec: ## Related - + Configuration options - + Env var reference - + Monitoring setup diff --git a/docs/deployment/environment-variables.mdx b/docs/vectoriadb/deployment/environment-variables.mdx similarity index 92% rename from docs/deployment/environment-variables.mdx rename to docs/vectoriadb/deployment/environment-variables.mdx index aa75f54..e493fd7 100644 --- a/docs/deployment/environment-variables.mdx +++ b/docs/vectoriadb/deployment/environment-variables.mdx @@ -111,13 +111,13 @@ data: ## Related - + Full configuration - + Container deployment - + Monitoring setup diff --git a/docs/deployment/health-monitoring.mdx b/docs/vectoriadb/deployment/health-monitoring.mdx similarity index 95% rename from docs/deployment/health-monitoring.mdx rename to docs/vectoriadb/deployment/health-monitoring.mdx index 5d5aba1..829a30d 100644 --- a/docs/deployment/health-monitoring.mdx +++ b/docs/vectoriadb/deployment/health-monitoring.mdx @@ -190,13 +190,13 @@ readinessProbe: ## Related - + Configuration options - + Container deployment - + Error types diff --git a/docs/deployment/production-config.mdx b/docs/vectoriadb/deployment/production-config.mdx similarity index 95% rename from docs/deployment/production-config.mdx rename to docs/vectoriadb/deployment/production-config.mdx index 7c6bc73..8651e5f 100644 --- a/docs/deployment/production-config.mdx +++ b/docs/vectoriadb/deployment/production-config.mdx @@ -146,13 +146,13 @@ export async function startupInitialization() { ## Related - + Container deployment - + Configuration reference - + Monitoring setup diff --git a/docs/get-started/installation.mdx b/docs/vectoriadb/get-started/installation.mdx similarity index 91% rename from docs/get-started/installation.mdx rename to docs/vectoriadb/get-started/installation.mdx index e43876e..15e13ea 100644 --- a/docs/get-started/installation.mdx +++ b/docs/vectoriadb/get-started/installation.mdx @@ -97,10 +97,10 @@ VectoriaDB is written in TypeScript and includes type definitions. No additional ## Next Steps - + Build your first semantic search - + Explore configuration options diff --git a/docs/get-started/quickstart.mdx b/docs/vectoriadb/get-started/quickstart.mdx similarity index 91% rename from docs/get-started/quickstart.mdx rename to docs/vectoriadb/get-started/quickstart.mdx index 9344dd1..1c26ef4 100644 --- a/docs/get-started/quickstart.mdx +++ b/docs/vectoriadb/get-started/quickstart.mdx @@ -125,16 +125,16 @@ for (const result of results) { ## Next Steps - + Learn about indexing options - + Master search queries - + Persist embeddings between restarts - + Scale to large datasets diff --git a/docs/get-started/welcome.mdx b/docs/vectoriadb/get-started/welcome.mdx similarity index 88% rename from docs/get-started/welcome.mdx rename to docs/vectoriadb/get-started/welcome.mdx index 7070838..88b7bad 100644 --- a/docs/get-started/welcome.mdx +++ b/docs/vectoriadb/get-started/welcome.mdx @@ -55,16 +55,16 @@ Search returns documents ranked by cosine similarity to your query. You can filt ## Next Steps - + Install VectoriaDB in your project - + Build your first semantic search - + Complete tool discovery guide - + Explore the full API diff --git a/docs/guides/alternatives/tfidf.mdx b/docs/vectoriadb/guides/alternatives/tfidf.mdx similarity index 95% rename from docs/guides/alternatives/tfidf.mdx rename to docs/vectoriadb/guides/alternatives/tfidf.mdx index 78c6f9e..c268d07 100644 --- a/docs/guides/alternatives/tfidf.mdx +++ b/docs/vectoriadb/guides/alternatives/tfidf.mdx @@ -185,13 +185,13 @@ const semanticResults = await vectoriaDB.searchByIds( ## Related - + Getting started - + Semantic search options - + Storage adapters diff --git a/docs/guides/core/adding-documents.mdx b/docs/vectoriadb/guides/core/adding-documents.mdx similarity index 91% rename from docs/guides/core/adding-documents.mdx rename to docs/vectoriadb/guides/core/adding-documents.mdx index cce949c..435f7e8 100644 --- a/docs/guides/core/adding-documents.mdx +++ b/docs/vectoriadb/guides/core/adding-documents.mdx @@ -127,13 +127,13 @@ For large imports, use `addMany` instead of calling `add` in a loop. Batch opera ## Related - + Understanding indexing - + Update existing documents - + Remove documents diff --git a/docs/guides/core/indexing-basics.mdx b/docs/vectoriadb/guides/core/indexing-basics.mdx similarity index 91% rename from docs/guides/core/indexing-basics.mdx rename to docs/vectoriadb/guides/core/indexing-basics.mdx index 869a2f2..4bf495c 100644 --- a/docs/guides/core/indexing-basics.mdx +++ b/docs/vectoriadb/guides/core/indexing-basics.mdx @@ -103,13 +103,13 @@ const db = new VectoriaDB({ ## Related - + Add single and batch documents - + Update metadata and text - + Query the index diff --git a/docs/guides/core/removing-documents.mdx b/docs/vectoriadb/guides/core/removing-documents.mdx similarity index 90% rename from docs/guides/core/removing-documents.mdx rename to docs/vectoriadb/guides/core/removing-documents.mdx index 0858315..743ec61 100644 --- a/docs/guides/core/removing-documents.mdx +++ b/docs/vectoriadb/guides/core/removing-documents.mdx @@ -113,13 +113,13 @@ For file or Redis storage, call `saveToStorage()` after batch removals to persis ## Related - + Add documents - + Update documents - + Persist changes diff --git a/docs/guides/core/updating-documents.mdx b/docs/vectoriadb/guides/core/updating-documents.mdx similarity index 91% rename from docs/guides/core/updating-documents.mdx rename to docs/vectoriadb/guides/core/updating-documents.mdx index 13b4029..f1fa314 100644 --- a/docs/guides/core/updating-documents.mdx +++ b/docs/vectoriadb/guides/core/updating-documents.mdx @@ -139,13 +139,13 @@ try { ## Related - + Add new documents - + Remove documents - + Query updated documents diff --git a/docs/guides/scaling/hnsw-configuration.mdx b/docs/vectoriadb/guides/scaling/hnsw-configuration.mdx similarity index 92% rename from docs/guides/scaling/hnsw-configuration.mdx rename to docs/vectoriadb/guides/scaling/hnsw-configuration.mdx index b7ce970..0f8240f 100644 --- a/docs/guides/scaling/hnsw-configuration.mdx +++ b/docs/vectoriadb/guides/scaling/hnsw-configuration.mdx @@ -143,13 +143,13 @@ const db = new VectoriaDB({ ## Related - + Introduction to HNSW - + Tune for your use case - + General performance tips diff --git a/docs/guides/scaling/hnsw-overview.mdx b/docs/vectoriadb/guides/scaling/hnsw-overview.mdx similarity index 89% rename from docs/guides/scaling/hnsw-overview.mdx rename to docs/vectoriadb/guides/scaling/hnsw-overview.mdx index ac2962a..b757616 100644 --- a/docs/guides/scaling/hnsw-overview.mdx +++ b/docs/vectoriadb/guides/scaling/hnsw-overview.mdx @@ -100,13 +100,13 @@ await db.saveToStorage(); // Saves HNSW structure too ## Related - + Parameter reference - + Optimize for your use case - + General performance tips diff --git a/docs/guides/scaling/hnsw-tuning.mdx b/docs/vectoriadb/guides/scaling/hnsw-tuning.mdx similarity index 91% rename from docs/guides/scaling/hnsw-tuning.mdx rename to docs/vectoriadb/guides/scaling/hnsw-tuning.mdx index 85c3d7b..7cab633 100644 --- a/docs/guides/scaling/hnsw-tuning.mdx +++ b/docs/vectoriadb/guides/scaling/hnsw-tuning.mdx @@ -153,13 +153,13 @@ If bulk indexing is too slow: ## Related - + Introduction to HNSW - + Parameter reference - + General performance tips diff --git a/docs/guides/search/basic-search.mdx b/docs/vectoriadb/guides/search/basic-search.mdx similarity index 92% rename from docs/guides/search/basic-search.mdx rename to docs/vectoriadb/guides/search/basic-search.mdx index 5577909..e64a227 100644 --- a/docs/guides/search/basic-search.mdx +++ b/docs/vectoriadb/guides/search/basic-search.mdx @@ -110,13 +110,13 @@ console.log('Found:', results.length); ## Related - + Filter search results - + Tune similarity thresholds - + Optimize search performance diff --git a/docs/guides/search/filtering.mdx b/docs/vectoriadb/guides/search/filtering.mdx similarity index 92% rename from docs/guides/search/filtering.mdx rename to docs/vectoriadb/guides/search/filtering.mdx index 83e68d4..3e8b1f8 100644 --- a/docs/guides/search/filtering.mdx +++ b/docs/vectoriadb/guides/search/filtering.mdx @@ -141,13 +141,13 @@ For large datasets with HNSW, VectoriaDB fetches extra candidates (3x topK) to a ## Related - + Search fundamentals - + Tune similarity - + Optimize search diff --git a/docs/guides/search/performance.mdx b/docs/vectoriadb/guides/search/performance.mdx similarity index 90% rename from docs/guides/search/performance.mdx rename to docs/vectoriadb/guides/search/performance.mdx index 1d24d26..520e88b 100644 --- a/docs/guides/search/performance.mdx +++ b/docs/vectoriadb/guides/search/performance.mdx @@ -49,7 +49,7 @@ const db = new VectoriaDB({ | 50,000 | ~250ms | ~1ms | | 100,000 | ~500ms | ~2ms | -See [HNSW Scaling](/guides/scaling/hnsw-overview) for details. +See [HNSW Scaling](/vectoriadb/guides/scaling/hnsw-overview) for details. ## Query Caching @@ -147,13 +147,13 @@ async function monitoredSearch(query: string, options?: SearchOptions) { ## Related - + Scale with HNSW - + Tune HNSW parameters - + Search fundamentals diff --git a/docs/guides/search/similarity-thresholds.mdx b/docs/vectoriadb/guides/search/similarity-thresholds.mdx similarity index 93% rename from docs/guides/search/similarity-thresholds.mdx rename to docs/vectoriadb/guides/search/similarity-thresholds.mdx index 2538fea..84f49c5 100644 --- a/docs/guides/search/similarity-thresholds.mdx +++ b/docs/vectoriadb/guides/search/similarity-thresholds.mdx @@ -152,13 +152,13 @@ Start with a lower threshold (0.3-0.4) and increase it if you're getting too man ## Related - + Search fundamentals - + Filter by metadata - + Optimize search diff --git a/docs/guides/storage/cache-invalidation.mdx b/docs/vectoriadb/guides/storage/cache-invalidation.mdx similarity index 93% rename from docs/guides/storage/cache-invalidation.mdx rename to docs/vectoriadb/guides/storage/cache-invalidation.mdx index 3d2ce2b..168064c 100644 --- a/docs/guides/storage/cache-invalidation.mdx +++ b/docs/vectoriadb/guides/storage/cache-invalidation.mdx @@ -166,13 +166,13 @@ try { ## Related - + Storage fundamentals - + File storage - + Production setup diff --git a/docs/guides/storage/file-adapter.mdx b/docs/vectoriadb/guides/storage/file-adapter.mdx similarity index 90% rename from docs/guides/storage/file-adapter.mdx rename to docs/vectoriadb/guides/storage/file-adapter.mdx index 44668f9..6bceaa0 100644 --- a/docs/guides/storage/file-adapter.mdx +++ b/docs/vectoriadb/guides/storage/file-adapter.mdx @@ -123,13 +123,13 @@ volumes: ## Related - + Storage fundamentals - + Multi-pod storage - + Cache control diff --git a/docs/guides/storage/memory-adapter.mdx b/docs/vectoriadb/guides/storage/memory-adapter.mdx similarity index 90% rename from docs/guides/storage/memory-adapter.mdx rename to docs/vectoriadb/guides/storage/memory-adapter.mdx index b9f6944..e2af4ea 100644 --- a/docs/guides/storage/memory-adapter.mdx +++ b/docs/vectoriadb/guides/storage/memory-adapter.mdx @@ -110,13 +110,13 @@ const db = new VectoriaDB({ ## Related - + Storage fundamentals - + Persist to disk - + Multi-pod storage diff --git a/docs/guides/storage/overview.mdx b/docs/vectoriadb/guides/storage/overview.mdx similarity index 87% rename from docs/guides/storage/overview.mdx rename to docs/vectoriadb/guides/storage/overview.mdx index 87b689c..816181f 100644 --- a/docs/guides/storage/overview.mdx +++ b/docs/vectoriadb/guides/storage/overview.mdx @@ -113,13 +113,13 @@ const tenantBIndex = new VectoriaDB({ ## Choosing an Adapter - + Single-server deployments - + Multi-pod environments - + Development and testing @@ -127,10 +127,10 @@ const tenantBIndex = new VectoriaDB({ ## Related - + Advanced cache control - + Production configuration diff --git a/docs/guides/storage/redis-adapter.mdx b/docs/vectoriadb/guides/storage/redis-adapter.mdx similarity index 93% rename from docs/guides/storage/redis-adapter.mdx rename to docs/vectoriadb/guides/storage/redis-adapter.mdx index f35773d..73af5f4 100644 --- a/docs/guides/storage/redis-adapter.mdx +++ b/docs/vectoriadb/guides/storage/redis-adapter.mdx @@ -174,13 +174,13 @@ try { ## Related - + Storage fundamentals - + Single-server storage - + Docker setup diff --git a/docs/guides/use-cases/tool-discovery.mdx b/docs/vectoriadb/guides/use-cases/tool-discovery.mdx similarity index 94% rename from docs/guides/use-cases/tool-discovery.mdx rename to docs/vectoriadb/guides/use-cases/tool-discovery.mdx index 1f15744..9785cd4 100644 --- a/docs/guides/use-cases/tool-discovery.mdx +++ b/docs/vectoriadb/guides/use-cases/tool-discovery.mdx @@ -244,19 +244,19 @@ for (const result of results) { ## Related - + Getting started - + Adding documents - + Query options - + Storage adapters - + Scaling to large datasets diff --git a/docs/integrations/enclave.mdx b/docs/vectoriadb/integrations/enclave.mdx similarity index 91% rename from docs/integrations/enclave.mdx rename to docs/vectoriadb/integrations/enclave.mdx index fbd580a..2dd719a 100644 --- a/docs/integrations/enclave.mdx +++ b/docs/vectoriadb/integrations/enclave.mdx @@ -102,13 +102,13 @@ const docResults = await searchByCategory('getting started', ['documentation']); ## Related - + FrontMCP integration - + Express integration - + Next.js integration diff --git a/docs/integrations/express.mdx b/docs/vectoriadb/integrations/express.mdx similarity index 93% rename from docs/integrations/express.mdx rename to docs/vectoriadb/integrations/express.mdx index 2f8c534..81101fd 100644 --- a/docs/integrations/express.mdx +++ b/docs/vectoriadb/integrations/express.mdx @@ -166,13 +166,13 @@ app.use('/api/search', searchLimiter); ## Related - + FrontMCP integration - + Next.js integration - + Production deployment diff --git a/docs/integrations/frontmcp.mdx b/docs/vectoriadb/integrations/frontmcp.mdx similarity index 93% rename from docs/integrations/frontmcp.mdx rename to docs/vectoriadb/integrations/frontmcp.mdx index 3f7dfe6..8480212 100644 --- a/docs/integrations/frontmcp.mdx +++ b/docs/vectoriadb/integrations/frontmcp.mdx @@ -105,13 +105,13 @@ server.tool('discover:tools', 'Find relevant tools for a query', async (params) ## Related - + Complete guide - + Enclave integration - + Express integration diff --git a/docs/integrations/nextjs.mdx b/docs/vectoriadb/integrations/nextjs.mdx similarity index 94% rename from docs/integrations/nextjs.mdx rename to docs/vectoriadb/integrations/nextjs.mdx index 7c2f620..c49b5ac 100644 --- a/docs/integrations/nextjs.mdx +++ b/docs/vectoriadb/integrations/nextjs.mdx @@ -194,13 +194,13 @@ export const runtime = 'nodejs'; ## Related - + Express integration - + FrontMCP integration - + Production deployment diff --git a/docs/integrations/overview.mdx b/docs/vectoriadb/integrations/overview.mdx similarity index 81% rename from docs/integrations/overview.mdx rename to docs/vectoriadb/integrations/overview.mdx index 4e39d33..e4161a2 100644 --- a/docs/integrations/overview.mdx +++ b/docs/vectoriadb/integrations/overview.mdx @@ -9,16 +9,16 @@ VectoriaDB integrates seamlessly with popular frameworks and tools. ## Available Integrations - + Intelligent tool discovery for MCP servers - + Semantic search in sandboxed environments - + REST API integration with Express.js - + Full-stack search with Next.js @@ -92,10 +92,10 @@ app.get('/search', async (req, res) => { ## Related - + Complete tool discovery guide - + Production deployment diff --git a/docs/troubleshooting/common-errors.mdx b/docs/vectoriadb/troubleshooting/common-errors.mdx similarity index 97% rename from docs/troubleshooting/common-errors.mdx rename to docs/vectoriadb/troubleshooting/common-errors.mdx index d654f59..c7beb3e 100644 --- a/docs/troubleshooting/common-errors.mdx +++ b/docs/vectoriadb/troubleshooting/common-errors.mdx @@ -328,10 +328,10 @@ async function safeOperation() { ## Related - + Frequently asked questions - + Programmatic error handling diff --git a/docs/troubleshooting/faq.mdx b/docs/vectoriadb/troubleshooting/faq.mdx similarity index 95% rename from docs/troubleshooting/faq.mdx rename to docs/vectoriadb/troubleshooting/faq.mdx index f885cb0..fa64f87 100644 --- a/docs/troubleshooting/faq.mdx +++ b/docs/vectoriadb/troubleshooting/faq.mdx @@ -20,7 +20,7 @@ Find answers to common questions about VectoriaDB. - **Privacy-first** applications where data can't leave the server - **Type-safe** metadata with TypeScript generics - For simple keyword matching without semantic understanding, consider the [TF-IDF variant](/guides/tfidf) instead. + For simple keyword matching without semantic understanding, consider the [TF-IDF variant](/vectoriadb/guides/alternatives/tfidf) instead. @@ -114,7 +114,7 @@ Find answers to common questions about VectoriaDB. }); ``` - See [HNSW guide](/guides/hnsw) for tuning details. + See [HNSW guide](/vectoriadb/guides/scaling/hnsw-overview) for tuning details. @@ -133,7 +133,7 @@ Find answers to common questions about VectoriaDB. await db.saveToStorage(); ``` - See [Persistence guide](/guides/persistence) for details. + See [Storage guide](/vectoriadb/guides/storage/overview) for details. @@ -213,10 +213,10 @@ Find answers to common questions about VectoriaDB. ## Related - + Error reference and solutions - + Programmatic error handling diff --git a/docs/updates.mdx b/docs/vectoriadb/updates.mdx similarity index 92% rename from docs/updates.mdx rename to docs/vectoriadb/updates.mdx index 31631d5..c2134a3 100644 --- a/docs/updates.mdx +++ b/docs/vectoriadb/updates.mdx @@ -71,10 +71,10 @@ For detailed release notes and download links, see the [GitHub Releases](https:/ ## Related - + Get started with VectoriaDB - + Common migration questions diff --git a/libs/vectoriadb/README.md b/libs/vectoriadb/README.md index 098e0aa..b88bc22 100644 --- a/libs/vectoriadb/README.md +++ b/libs/vectoriadb/README.md @@ -859,8 +859,8 @@ Memory efficient with Float32 arrays: **Without HNSW (brute-force):** - **Complexity**: O(n) where n = number of documents -- **Performance**: <10ms for 10,000 documents on modern hardware -- **Best for**: <10,000 documents +- **Performance**: <10ms for 10,000 documents on modern hardware +- **Best for**: <10,000 documents **With HNSW (approximate nearest neighbor):** @@ -962,7 +962,7 @@ All tests use mocked transformers.js to avoid downloading models during CI/CD, m VectoriaDB is ideal for: -- **Small to medium datasets** (<100k documents) +- **Small to medium datasets** (<100k documents) - **Fast in-memory search** without external dependencies - **Embedded applications** that need semantic search - **Development and testing** before scaling to production DBs diff --git a/package.json b/package.json index c068471..89a544a 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "lint": "nx run-many -t lint --outputStyle stream", "format": "prettier --write .", "format:check": "prettier --check .", - "docs": "cd docs && mint dev --port 4301" + "docs": "mint dev --port 4301" }, "private": true, "devDependencies": {