Skip to content

Conversation

simon-dew
Copy link
Contributor

@simon-dew simon-dew commented Oct 13, 2025

Docs issue: AV-91970

Docs preview: Use Vector Indexes for AI Applications and more
Credentials: Preview docs for internal review

Must be merged at the same time as:

Important

  • Avoid merging small edits directly into this PR. Where possible, try to use separate PRs to merge any further changes into the AV-91970-8-0-docs-uptake-capella branch.
  • Rebase and merge, or merge commit! Do not squash and merge

sarahlwelton and others added 30 commits July 10, 2025 15:53
* [AV-105751] First draft of additional store params documentation on Capella

* [AV-104690] Add HEAD.yml for previews
* [AV-104690] First draft of Capella version of synonym search updates, adapted from DOC-12754

* [AV-104690] Applicable comment from peer review on DOC-12754

* [AV-104690] Adjust set-type-identifier based on actual state of Capella UI

* [AV-104690] Add HEAD.yml for previews

* [AV-104690] Fix UI inconsistency

* [AV-104690] Address peer review comments
* [AV-104691] First draft of synonym sources documentation for Capella

* [AV-104690] Add HEAD.yml for previews

* [AV-104691] Update to remove inconsistencies in procedure for add-synonym-source

* [AV-104691] Change highlight style in synonym search example query to better show in Capella

* [AV-104691] Fix typos

* Update modules/search/pages/run-searches.adoc

Co-authored-by: Daniel Nicholson <[email protected]>

* Update modules/search/pages/synonyms/add-synonym-source.adoc

Co-authored-by: Daniel Nicholson <[email protected]>

* Update modules/search/pages/synonyms/create-synonym-collection-docs.adoc

Co-authored-by: Daniel Nicholson <[email protected]>

---------

Co-authored-by: Daniel Nicholson <[email protected]>
* Move pages to Indexes
* Move diagrams to Indexes
* Move examples to Indexes
* Move images to Indexes
* Move indexes concept doc back to docs-server
* Remove unused image files
* Update page aliases
* Update links to GSI pages
* Update coordinates of example files
* Update GSI image coordinates
* Update GSI diagram coordinates
* Driveby fix unsupported icons
* Minor changes to indexing overview and content order
* Move covering indexes, group agg pushdown
* Update links to covering indexes, grouping and agg pushdown
* Driveby fix broken link
…nerator (#280)

* Update links to Query Settings REST API
* Update includes of Query Settings REST API
* Driveby fixes for CURL() function
* Update links to Query Settings examples
* Add table-style partial
* Add table-style for CURL() reference
* Add Streaming Completed Requests
* Try to make tabs sync with only partial success
* Add system:completed_requests_history to sysinfo
* Add links to Admin REST API
* Update table formatting for sysinfo
* Add links to gzip and jq
Fix grammar in the pre-filtering section
---------

Co-authored-by: rakhi-prathap <[email protected]>
* DOC-13223: rebased to 7.6

* DOC-13223: changed to note

* Update index-partitioning.adoc
---------

Co-authored-by: Pallavi-Janardhan <[email protected]>
* Removing single reference to memecached bukets

* Removing Couchbase and Ephemeral at Richard's suggestion
rakhi-prathap and others added 14 commits October 4, 2025 00:24
* Fix property name
* Add completed-stream-size to Configure Queries ToC
* Vale updates
* Update preview config
* [AV-110544] First draft/attempt at figuring out how to document unexpected Search UI changes

* [AV-110544] Quick procedure tweak
* Remove credentials section
* Remove 7.6 sidebar
* TEMP: Update preview config
Full draft of the vector index concepts.
---------

Co-authored-by: Simon Dew <[email protected]>
* Add vector index syntax to EBNF
* Update script to use Railroad Diagram Generator 2.1
* Update syntax diagrams
* Update primary index functionality
* Update nav
* Update indexing overview
* Update index types
* Add ALTER VECTOR INDEX
* Add CREATE VECTOR INDEX
* Add DROP VECTOR INDEX
* Update ALTER INDEX
* Update BUILD INDEX
* Update CREATE INDEX
* Update CREATE PRIMARY INDEX
* Update DROP INDEX
* UPDATE DROP PRIMARY INDEX
* Update toc depth
* Adjusting related links
* Add composite vector index example
* Add examples to ALTER VECTOR INDEX
* Add clarification about base64 decoding
* Update CREATE INDEX examples

* DOC-12940: GSI Vector Index not supported on Windows (#406)
* Update Functions overview page
* Update nav
* Add Vector Functions page
* Include ISVECTOR in the Type functions
* Add Vector Functions
* Tweak type functions
* Add formulas
* TEMP: Preview config for feature branch
* Fix links, tags, anchors, and includes
* Tweak examples for consistency and formatting
* Move composite examples to separate files — use the View button as intended
… for L2 and Euclidean (#422)

* Added note to Euclidean Distance to explain that Couchbase uses Euclidean Squared Distance instead behind the scenes.
* Changed "FTS Vector Index" to "Search Vector Index" which is PM's current nomenclature.

* Fixing a typo spotted by Nischal
* Use sequence diagrams for clearer readability
* Minor wording tweaks
* Apply Vale suggestions for DDL and DML
* Update Search Vector workflow diagram
* Rename Vector Indexes top-level topic
* Rename Choose the Right Vector Index topic
* An Search Vector → a Search Vector
* Make vector index topic names consistent
* Simplify xrefs in nav
* Explain how the appropriate index is selected
* Explain all ANN_DISTANCE arguments in Hyperscale Vector index guide
* Index Service not Query Service
* ORDER BY not GROUP BY
* Similarity is optional
* Description is optional
* Composite Vector index with leading scalar key
* HVI and CVI are supported on Windows
* Include persist_full_vector
* Remove trailing spaces
* Scan for typos
* Capitalization of Hyperscale Vector and Composite Vector
* Examples on this page
* Remove feature branch preview config
simon-dew and others added 13 commits October 13, 2025 15:45
* Update links to Capella
* Hide service-level settings
* Update replica examples
* Remove page edition
* Add Vector Indexes to Developer Intro page
* Add Migration Tutorial to server Developer Intro page
* Fix Migration Tutorial: no empty headings in navigation
* [AV-102227] First draft of creating hyperscale and composite vector indexes based on Figma UI flow. Putting contents in partials to insert in Gary's content - might need to move folder location later.

* [AV-102227] Change folder structure to keep partials with the rest of the content Gary's writing

* [AV-102227] Adding in info about configuring filter fields and the different index configuration settings

* [AV-102227] Update procedures after reviewing UI for limitations and extra options

* [AV-102227] Update procedure based on significant UI changes

* [AV-102227] Add instructions for creating FTS index with Vector Indexes flow

* [AV-102227] Update FTS Vector Index -> Search Vector Index

* [AV-102227] Updating procedures based on UI changes

* [AV-102227] Update Search Vector index procedure and embedding dimension number

* [AV-102227] Replace instances of an Search

* [AV-102227] Insert partials into Gary's docs

* Update modules/vector-search/pages/vector-search.adoc

* Fix bad find and replace

* [AV-102227] Comments from SME review

* [AV-102227] Change training list value guidance

* [AV-102227] Link fixes + peer review comments

* Apply suggestions from code review

Co-authored-by: Simon Dew <[email protected]>

* [AV-102227] HyperScale -> Hyperscale

---------

Co-authored-by: Simon Dew <[email protected]>
---------

Co-authored-by: rakhi-prathap <[email protected]>
* Update Vector Search examples
* Update Vector Index examples
* Update Query examples
* Update examples for Hyperscale Vector indexes
* Update examples for Composite Vector indexes
* Update ALTER INDEX for Capella
* Update ALTER VECTOR INDEX for Capella
* Update common errors
* Minor tweaks
@simon-dew
Copy link
Contributor Author

Important

Rebase and merge, or merge commit! Do not squash and merge

@simon-dew simon-dew marked this pull request as ready for review October 17, 2025 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants