Add Vector Sets (Preview) command documentation#1839
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds end-user documentation for the Vector Set (Preview) feature, and integrates that documentation into the public docs site navigation and API compatibility matrix.
Changes:
- Adds a new
vector-sets.mdcommand reference page covering Vector Set commands, options, limits, and examples. - Updates the docs sidebar to include the new Vector Sets page under Commands.
- Extends the API compatibility page with a VECTOR SET (Preview) section listing implemented and stubbed commands.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| website/sidebars.js | Adds the Vector Sets docs page to the Commands sidebar list. |
| website/docs/commands/vector-sets.md | New Vector Set command documentation page (preview), including syntax, options, limits, and examples. |
| website/docs/commands/api-compatibility.md | Adds a VECTOR SET (Preview) block listing supported vs not-yet-implemented commands. |
badrishc
force-pushed
the
badrishc/vector-sets-docs
branch
10 times, most recently
from
bbecdaf to
16b17f3
Compare
badrishc
force-pushed
the
badrishc/vector-sets-docs
branch
from
16b17f3 to
c8be463
Compare
kevin-montrose
approved these changes
Jun 1, 2026
Authors website/docs/commands/vector-sets.md modeled after the existing
range-index.md page. Covers all currently-implemented Vector Set commands
(VADD, VSIM, VEMB, VDIM, VINFO, VGETATTR, VREM) with options, defaults,
limits, errors, and an end-to-end example session. Includes a Filter
Expression syntax reference, quantization/distance tables, and an
explicit 'Not Yet Implemented' table for VCARD/VISMEMBER/VLINKS/
VRANDMEMBER/VSETATTR (which are currently parser stubs returning +OK).
Also wires the new page into the docs site:
- sidebars.js: adds commands/vector-sets to the Commands sidebar
- api-compatibility.md: adds a VECTOR SET (Preview) block listing
the 7 implemented commands and 5 not-yet-implemented stubs
Adds a 'What's New' section to the top-level README.md advertising
Vector Sets (Preview), Range Index (Preview), and the upcoming Garnet
paper at VLDB 2026.
All content was validated against the actual source in
libs/server/Resp/Vector/ rather than the (outdated) dev guide checklist.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
badrishc
force-pushed
the
badrishc/vector-sets-docs
branch
from
8168678 to
648cdf9
Compare
kevin-montrose
approved these changes
Jun 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Authors website/docs/commands/vector-sets.md modeled after the existing range-index.md page. Covers all currently-implemented Vector Set commands (VADD, VSIM, VEMB, VDIM, VINFO, VGETATTR, VREM) with options, defaults, limits, errors, and an end-to-end example session. Includes a Filter Expression syntax reference, quantization/distance tables, and an explicit 'Not Yet Implemented' table for VCARD/VISMEMBER/VLINKS/ VRANDMEMBER/VSETATTR (which are currently parser stubs returning +OK).
Also wires the new page into the docs site:
All content was validated against the actual source in libs/server/Resp/Vector/ rather than the (outdated) dev guide checklist.