Documentation

The package reference on pkg.go.dev
is the source of truth for individual exported types, functions, fields, and
methods. These guides cover behavior that spans several API declarations or is
important to operating and maintaining a durable collection.

User guides

• Collections: schema creation, writes, reads, iteration, DDL,
  compaction, and handle lifecycle.
• Queries and filters: vector search, FTS and filter-only queries,
  projections, grouping, SQL predicates, and query parameters.
• Multi-query and reranking: hybrid candidate generation,
  reciprocal-rank fusion, weighted fusion, and callback rerankers.
• Full-text search: tokenization, query syntax, BM25,
  dictionaries, postings, and persistence.
• Runtime configuration: process-wide concurrency, memory
  admission, logging, planner thresholds, Jieba resources, and statistics.

Maintainer guides

• Vector indexes: supported index matrix, quantization,
  build/search behavior, persistence, and refinement.
• Storage and recovery: native disk format, WAL, manifests,
  segments, crash consistency, and atomic schema changes.

The maintainer guides describe the current native Go implementation. They are
not compatibility promises for the C++ zvec API or disk format.

Local development

The documentation site uses VuePress and vuepress-theme-hope:

cd docs
npm install
npm run docs:dev

Build the static site with npm run docs:build. Generated files are written to
docs/.vuepress/dist and are not committed.

Documentation policy

Keep API-local facts in Go comments and executable Example functions. Add to
these guides only when a rule crosses API boundaries, defines persisted state,
or explains an operational constraint. Tests and workflow files remain the
source of truth for test coverage and CI configuration.