Merge pull request #2204 from qdrant/docs-restructure-1

Restructure Docs - Stage 1
This commit is contained in:
kanungle
2026-03-17 07:49:17 -05:00
committed by GitHub
55 changed files with 225 additions and 127 deletions
@@ -1,66 +0,0 @@
---
title: Concepts
weight: 8
# If the index.md file is empty, the link to the section will be hidden from the sidebar
partition: qdrant
---
# Concepts
Think of these concepts as a glossary. Each of these concepts include a link to
detailed information, usually with examples. If you're new to AI, these concepts
can help you learn more about AI and the Qdrant approach.
## Collections
[Collections](/documentation/concepts/collections/) define a named set of points that you can use for your search.
## Payload
A [Payload](/documentation/concepts/payload/) describes information that you can store with vectors.
## Points
[Points](/documentation/concepts/points/) are a record which consists of a vector and an optional payload.
## Search
[Search](/documentation/concepts/search/) describes _similarity search_, which set up related objects close to each other in vector space.
## Search Relevance
[Search Relevance](/documentation/concepts/search-relevance/) describes techniques to improve the ranking of search results by considering factors beyond vector similarity scores.
## Explore
[Explore](/documentation/concepts/explore/) includes several APIs for exploring data in your collections.
## Hybrid Queries
[Hybrid Queries](/documentation/concepts/hybrid-queries/) combines multiple queries or performs them in more than one stage.
## Filtering
[Filtering](/documentation/concepts/filtering/) defines various database-style clauses, conditions, and more.
## Inference
[Inference](/documentation/concepts/inference/) is the process of generating vectors (embeddings) from text or an image.
## Optimizer
[Optimizer](/documentation/concepts/optimizer/) describes options to rebuild
database structures for faster search. They include a vacuum, a merge, and an
indexing optimizer.
## Storage
[Storage](/documentation/concepts/storage/) describes the configuration of storage in segments, which include indexes and an ID mapper.
## Indexing
[Indexing](/documentation/concepts/indexing/) lists and describes available indexes. They include payload, vector, sparse vector, and a filterable index.
## Snapshots
[Snapshots](/documentation/concepts/snapshots/) describe the backup/restore process (and more) for each node at specific times.
@@ -2,7 +2,7 @@
#Delimiter files are used to separate the list of documentation pages into sections. #Delimiter files are used to separate the list of documentation pages into sections.
title: "Ecosystem" title: "Ecosystem"
type: delimiter type: delimiter
weight: 10 # Position before Integrations (weight 17) weight: 300 # Change this weight to change order of sections
sitemapExclude: True sitemapExclude: True
_build: _build:
publishResources: false publishResources: false
@@ -2,7 +2,7 @@
#Delimiter files are used to separate the list of documentation pages into sections. #Delimiter files are used to separate the list of documentation pages into sections.
title: "Getting Started" title: "Getting Started"
type: delimiter type: delimiter
weight: 1 # Change this weight to change order of sections weight: 100 # Change this weight to change order of sections
sitemapExclude: True sitemapExclude: True
_build: _build:
publishResources: false publishResources: false
@@ -2,7 +2,7 @@
#Delimiter files are used to separate the list of documentation pages into sections. #Delimiter files are used to separate the list of documentation pages into sections.
title: "Support" title: "Support"
type: delimiter type: delimiter
weight: 30 # Change this weight to change order of sections weight: 500 # Change this weight to change order of sections
sitemapExclude: True sitemapExclude: True
_build: _build:
publishResources: false publishResources: false
@@ -2,7 +2,7 @@
#Delimiter files are used to separate the list of documentation pages into sections. #Delimiter files are used to separate the list of documentation pages into sections.
title: "Tutorials" title: "Tutorials"
type: delimiter type: delimiter
weight: 15 # Change this weight to change order of sections weight: 400 # Change this weight to change order of sections
sitemapExclude: True sitemapExclude: True
_build: _build:
publishResources: false publishResources: false
@@ -2,7 +2,7 @@
#Delimiter files are used to separate the list of documentation pages into sections. #Delimiter files are used to separate the list of documentation pages into sections.
title: "User Manual" title: "User Manual"
type: delimiter type: delimiter
weight: 7 # Change this weight to change order of sections weight: 200 # Change this weight to change order of sections
sitemapExclude: True sitemapExclude: True
_build: _build:
publishResources: false publishResources: false
@@ -1,6 +1,6 @@
--- ---
title: "Qdrant Edge" title: "Qdrant Edge"
weight: 13 weight: 315
partition: qdrant partition: qdrant
--- ---
@@ -1,6 +1,6 @@
--- ---
title: FAQ title: FAQ
weight: 31 weight: 505
partition: qdrant partition: qdrant
# If the index.md file `is_empty`, the sidebar will display the first child link as the main entry # If the index.md file `is_empty`, the sidebar will display the first child link as the main entry
is_empty: true is_empty: true
@@ -1,6 +1,6 @@
--- ---
title: "FastEmbed" title: "FastEmbed"
weight: 11 weight: 305
partition: qdrant partition: qdrant
--- ---
@@ -1,9 +0,0 @@
---
title: Guides
weight: 9
# If the index.md file `is_empty`, the sidebar will display the first child link as the main entry
is_empty: true
partition: qdrant
build:
render: never
---
@@ -1,8 +1,10 @@
--- ---
title: Inference title: Inference
weight: 65 weight: 220
partition: qdrant
aliases: aliases:
- ../inference - ../inference
- /documentation/concepts/inference/
--- ---
# Inference # Inference
@@ -1,6 +1,6 @@
--- ---
title: API & SDKs title: API & SDKs
weight: 5 weight: 230
partition: qdrant partition: qdrant
--- ---
@@ -0,0 +1,41 @@
---
title: Manage Data
weight: 205
partition: qdrant
---
# Manage Data
Learn how to structure, store, and organize your data in Qdrant. These pages cover the core building blocks — from individual records and the vectors that represent them, to collections, payloads, and the indexing and quantization options that control how data is stored and retrieved.
## Points
[Points](/documentation/manage-data/points/) are the fundamental unit of data in Qdrant — each point is a record consisting of a vector and an optional payload.
## Vectors
[Vectors](/documentation/manage-data/vectors/) define how data is represented in vector space, including support for dense, sparse, and multivector configurations.
## Payload
A [Payload](/documentation/manage-data/payload/) is structured metadata you can attach to a point, enabling filtering and enriched search results.
## Collections
[Collections](/documentation/manage-data/collections/) are named groups of points that share the same vector configuration and serve as the top-level organizational unit in Qdrant.
## Storage
[Storage](/documentation/manage-data/storage/) describes how Qdrant persists vector and payload data, including segment structure and in-memory vs. on-disk options.
## Indexing
[Indexing](/documentation/manage-data/indexing/) covers the available index types — payload, vector, sparse, and filterable — and how they accelerate search and filtering.
## Quantization
[Quantization](/documentation/manage-data/quantization/) reduces memory usage by compressing vectors, with options for scalar, product, and binary quantization.
## Multitenancy
[Multitenancy](/documentation/manage-data/multitenancy/) explains strategies for isolating data across multiple users or tenants within a single Qdrant deployment.
@@ -1,10 +1,11 @@
--- ---
title: Collections title: Collections
weight: 30 weight: 20
aliases: aliases:
- ../collections - ../collections
- /concepts/collections/ - /concepts/collections/
- /documentation/frameworks/fondant/documentation/concepts/collections/ - /documentation/frameworks/fondant/documentation/concepts/collections/
- /documentation/concepts/collections/
--- ---
# Collections # Collections
@@ -1,8 +1,9 @@
--- ---
title: Indexing title: Indexing
weight: 90 weight: 30
aliases: aliases:
- ../indexing - ../indexing
- /documentation/concepts/indexing/
--- ---
# Indexing # Indexing
@@ -1,10 +1,11 @@
--- ---
title: Multitenancy title: Multitenancy
weight: 70 weight: 40
aliases: aliases:
- ../tutorials/multiple-partitions - ../tutorials/multiple-partitions
- /tutorials/multiple-partitions/ - /tutorials/multiple-partitions/
- /documentation/guides/multiple-partitions/ - /documentation/guides/multiple-partitions/
- /documentation/guides/multitenancy/
--- ---
# Configure Multitenancy # Configure Multitenancy
@@ -1,8 +1,9 @@
--- ---
title: Payload title: Payload
weight: 45 weight: 15
aliases: aliases:
- ../payload - ../payload
- /documentation/concepts/payload/
--- ---
# Payload # Payload
@@ -1,8 +1,9 @@
--- ---
title: Points title: Points
weight: 40 weight: 5
aliases: aliases:
- ../points - ../points
- /documentation/concepts/points/
--- ---
# Points # Points
@@ -1,10 +1,11 @@
--- ---
title: Quantization title: Quantization
weight: 90 weight: 35
aliases: aliases:
- ../quantization - ../quantization
- /articles/dedicated-service/documentation/guides/quantization/ - /articles/dedicated-service/documentation/guides/quantization/
- /guides/quantization/ - /guides/quantization/
- /documentation/guides/quantization/
--- ---
# Quantization # Quantization
@@ -1,8 +1,9 @@
--- ---
title: Storage title: Storage
weight: 80 weight: 25
aliases: aliases:
- ../storage - ../storage
- /documentation/concepts/storage/
--- ---
# Storage # Storage
@@ -1,8 +1,9 @@
--- ---
title: Vectors title: Vectors
weight: 41 weight: 10
aliases: aliases:
- /vectors - /vectors
- /documentation/concepts/vectors/
--- ---
@@ -0,0 +1,61 @@
---
title: Operations
weight: 215
partition: qdrant
---
# Operations
Everything you need to deploy, configure, and run Qdrant in production. These pages cover installation, capacity planning, distributed setups, security, monitoring, performance optimization, and troubleshooting.
## Capacity Planning
[Capacity Planning](/documentation/operations/capacity-planning/) helps you estimate memory and storage requirements based on your vector dimensions, quantization settings, and dataset size.
## Installation
[Installation](/documentation/operations/installation/) covers how to run Qdrant using Docker, from packages, or from source, including basic configuration options.
## Snapshots
[Snapshots](/documentation/operations/snapshots/) describe how to back up and restore collections at a point in time, for individual nodes or the full cluster.
## Usage Statistics
[Usage Statistics](/documentation/operations/usage-statistics/) explains the anonymized telemetry Qdrant collects and how to opt out.
## Monitoring & Telemetry
[Monitoring](/documentation/operations/monitoring/) covers Qdrant's metrics endpoint, Prometheus integration, and health-check APIs for observability.
## Security
[Security](/documentation/operations/security/) explains how to enable API key authentication and TLS to secure your Qdrant instance.
## Troubleshooting
[Troubleshooting](/documentation/operations/common-errors/) lists common errors and their solutions to help diagnose issues quickly.
## Configuration
[Configuration](/documentation/operations/configuration/) documents all available Qdrant configuration file settings and environment variable overrides.
## Administration
[Administration](/documentation/operations/administration/) covers runtime administration tools, including recovery mode and collection locking.
## Distributed Deployment
[Distributed Deployment](/documentation/operations/distributed_deployment/) explains how to run Qdrant as a multi-node cluster, including sharding, replication, and consensus.
## Running with GPU
[Running with GPU](/documentation/operations/running-with-GPU/) describes how to enable GPU-accelerated indexing using dedicated Qdrant Docker images for NVIDIA and AMD GPUs.
## Optimize Performance
[Optimize Performance](/documentation/operations/optimize/) walks through three main strategies for tuning Qdrant for high speed, low memory, or high precision workloads.
## Optimizer
[Optimizer](/documentation/operations/optimizer/) describes the background optimizer process that rebuilds segments to improve search performance over time.
@@ -1,8 +1,9 @@
--- ---
title: Administration title: Administration
weight: 20 weight: 55
aliases: aliases:
- ../administration - ../administration
- /documentation/guides/administration/
--- ---
# Administration # Administration
@@ -1,9 +1,10 @@
--- ---
title: Capacity Planning title: Capacity Planning
weight: 40 weight: 5
aliases: aliases:
- capacity - capacity
- /documentation/cloud/capacity-sizing - /documentation/cloud/capacity-sizing
- /documentation/guides/capacity-planning/
--- ---
# Capacity Planning # Capacity Planning
@@ -1,9 +1,10 @@
--- ---
title: Troubleshooting title: Troubleshooting
weight: 150 weight: 45
aliases: aliases:
- ../tutorials/common-errors - ../tutorials/common-errors
- /documentation/troubleshooting/ - /documentation/troubleshooting/
- /documentation/guides/common-errors/
--- ---
# Solving common errors # Solving common errors
@@ -1,9 +1,10 @@
--- ---
title: Configuration title: Configuration
weight: 120 weight: 50
aliases: aliases:
- ../configuration - ../configuration
- /guides/configuration/ - /guides/configuration/
- /documentation/guides/configuration/
--- ---
# Configuration # Configuration
@@ -1,9 +1,10 @@
--- ---
title: Distributed Deployment title: Distributed Deployment
weight: 80 weight: 60
aliases: aliases:
- ../distributed_deployment - ../distributed_deployment
- /guides/distributed_deployment - /guides/distributed_deployment
- /documentation/guides/distributed_deployment/
--- ---
# Distributed deployment # Distributed deployment
@@ -4,7 +4,7 @@ weight: 10
aliases: aliases:
- ../install - ../install
- ../installation - ../installation
- ../guides - /documentation/guides/installation/
--- ---
# Installation requirements # Installation requirements
@@ -1,8 +1,9 @@
--- ---
title: Monitoring & Telemetry title: Monitoring & Telemetry
weight: 110 weight: 35
aliases: aliases:
- ../monitoring - ../monitoring
- /documentation/guides/monitoring/
--- ---
# Monitoring & Telemetry # Monitoring & Telemetry
@@ -1,8 +1,9 @@
--- ---
title: Optimize Performance title: Optimize Performance
weight: 50 weight: 70
aliases: aliases:
- ../tutorials/optimize - ../tutorials/optimize
- /documentation/guides/optimize/
--- ---
# Optimizing Qdrant Performance: Three Scenarios # Optimizing Qdrant Performance: Three Scenarios
@@ -1,8 +1,9 @@
--- ---
title: Optimizer title: Optimizer
weight: 70 weight: 75
aliases: aliases:
- ../optimizer - ../optimizer
- /documentation/concepts/optimizer/
--- ---
# Optimizer # Optimizer
@@ -1,6 +1,8 @@
--- ---
title: Running with GPU title: Running with GPU
weight: 30 weight: 65
aliases:
- /documentation/guides/running-with-GPU/
--- ---
# Running Qdrant with GPU Support # Running Qdrant with GPU Support
@@ -1,8 +1,9 @@
--- ---
title: Security title: Security
weight: 130 weight: 40
aliases: aliases:
- ../security - ../security
- /documentation/guides/security/
--- ---
# Security # Security
@@ -1,8 +1,9 @@
--- ---
title: Snapshots title: Snapshots
weight: 110 weight: 25
aliases: aliases:
- ../snapshots - ../snapshots
- /documentation/concepts/snapshots/
--- ---
# Snapshots # Snapshots
@@ -1,9 +1,10 @@
--- ---
title: Usage Statistics title: Usage Statistics
weight: 140 weight: 30
aliases: aliases:
- ../telemetry - ../telemetry
- /documentation/guides/telemetry - /documentation/guides/telemetry
- /documentation/guides/usage-statistics/
--- ---
# Usage statistics # Usage statistics
@@ -1,9 +1,11 @@
--- ---
title: Overview title: Overview
weight: 3 weight: 105
aliases: aliases:
- overview - overview
- orientation - orientation
- concepts
- guides
partition: qdrant partition: qdrant
--- ---
@@ -1,6 +1,6 @@
--- ---
title: Understanding Vector Search in Qdrant title: Understanding Vector Search in Qdrant
weight: 2 weight: 10
social_preview_image: /docs/gettingstarted/vector-social.png social_preview_image: /docs/gettingstarted/vector-social.png
--- ---
@@ -1,6 +1,6 @@
--- ---
title: What is Qdrant? title: What is Qdrant?
weight: 1 weight: 5
aliases: aliases:
- overview - overview
partition: qdrant partition: qdrant
@@ -1,6 +1,6 @@
--- ---
title: "Qdrant MCP Server" title: "Qdrant MCP Server"
weight: 12 weight: 310
type: external-link type: external-link
external_url: https://github.com/qdrant/mcp-server-qdrant external_url: https://github.com/qdrant/mcp-server-qdrant
partition: qdrant partition: qdrant
@@ -1,6 +1,6 @@
--- ---
title: Qdrant Quickstart title: Qdrant Quickstart
weight: 4 weight: 110
partition: qdrant partition: qdrant
aliases: aliases:
- quick_start - quick_start
@@ -1,6 +1,6 @@
--- ---
title: Release Notes title: Release Notes
weight: 32 weight: 510
partition: qdrant partition: qdrant
type: external-link type: external-link
external_url: https://github.com/qdrant/qdrant/releases external_url: https://github.com/qdrant/qdrant/releases
@@ -0,0 +1,37 @@
---
title: Search
weight: 210
partition: qdrant
---
# Search
Explore Qdrant's search capabilities, from basic similarity search to advanced hybrid and multimodal queries. These pages cover how to find relevant results, apply filters, combine query types, and tune search quality and latency.
## Search
[Search](/documentation/search/search/) describes similarity search — finding points whose vectors are closest to a query vector in the configured vector space.
## Filtering
[Filtering](/documentation/search/filtering/) lets you narrow results using payload conditions, combining database-style clauses with vector search for precise retrieval.
## Hybrid Queries
[Hybrid Queries](/documentation/search/hybrid-queries/) combine multiple queries or execute them in stages, enabling fusion of dense and sparse results and complex re-ranking pipelines.
## Explore
[Explore](/documentation/search/explore/) covers discovery APIs such as recommendations and random sampling for browsing and navigating collections.
## Text Search
[Text Search](/documentation/search/text-search/) explains Qdrant's built-in full-text search capabilities and how to combine them with vector search.
## Search Relevance
[Search Relevance](/documentation/search/search-relevance/) describes techniques to improve result ranking beyond raw vector similarity, including score boosting and re-ranking strategies.
## Low-Latency Search
[Low-Latency Search](/documentation/search/low-latency-search/) covers configuration and design patterns for achieving the fastest possible query response times.
@@ -1,8 +1,9 @@
--- ---
title: Explore title: Explore
weight: 55 weight: 20
aliases: aliases:
- ../explore - ../explore
- /documentation/concepts/explore/
--- ---
# Explore the data # Explore the data
@@ -1,8 +1,9 @@
--- ---
title: Filtering title: Filtering
weight: 60 weight: 10
aliases: aliases:
- ../filtering - ../filtering
- /documentation/concepts/filtering/
--- ---
# Filtering # Filtering
@@ -1,9 +1,10 @@
--- ---
title: Hybrid Queries #required title: Hybrid Queries
weight: 57 # This is the order of the page in the sidebar. The lower the number, the higher the page will be in the sidebar. weight: 15
aliases: aliases:
- ../hybrid-queries - ../hybrid-queries
hideInSidebar: false # Optional. If true, the page will not be shown in the sidebar. It can be used in regular documentation pages and in documentation section pages (_index.md). - /documentation/concepts/hybrid-queries/
hideInSidebar: false
--- ---
# Hybrid and Multi-Stage Queries # Hybrid and Multi-Stage Queries
@@ -1,6 +1,8 @@
--- ---
title: Low-Latency Search title: Low-Latency Search
weight: 60 weight: 35
aliases:
- /documentation/guides/low-latency-search/
--- ---
# Tips for Low-Latency Search with Qdrant # Tips for Low-Latency Search with Qdrant
@@ -1,6 +1,8 @@
--- ---
title: Search Relevance title: Search Relevance
weight: 52 weight: 30
aliases:
- /documentation/concepts/search-relevance/
--- ---
# Search Relevance # Search Relevance
@@ -1,8 +1,9 @@
--- ---
title: Search title: Search
weight: 50 weight: 5
aliases: aliases:
- ../search - ../search
- /documentation/concepts/search/
--- ---
# Similarity search # Similarity search
@@ -1,8 +1,9 @@
--- ---
title: Text Search title: Text Search
weight: 100 weight: 25
aliases: aliases:
- ../text-search - ../text-search
- /documentation/guides/text-search/
--- ---
## Text Search ## Text Search
@@ -1,6 +1,6 @@
--- ---
title: Basics title: Basics
weight: 17 weight: 410
is_empty: false is_empty: false
aliases: aliases:
- how-to - how-to
@@ -1,6 +1,6 @@
--- ---
title: Develop & Implement title: Develop & Implement
weight: 21 weight: 425
is_empty: false is_empty: false
partition: qdrant partition: qdrant
--- ---
@@ -1,6 +1,6 @@
--- ---
title: Overview title: Overview
weight: 16 weight: 405
is_empty: false is_empty: false
aliases: aliases:
- how-to - how-to
@@ -1,6 +1,6 @@
--- ---
title: Operations & Scale title: Operations & Scale
weight: 20 weight: 420
is_empty: false is_empty: false
aliases: aliases:
- how-to - how-to
@@ -1,6 +1,6 @@
--- ---
title: Search Engineering title: Search Engineering
weight: 18 weight: 415
is_empty: false is_empty: false
aliases: aliases:
- how-to - how-to
@@ -1,6 +1,6 @@
--- ---
title: Qdrant Web UI title: Qdrant Web UI
weight: 6 weight: 225
partition: qdrant partition: qdrant
aliases: aliases:
- /documentation/web-ui/ - /documentation/web-ui/