Skip to content

Conversation

@amalhotra-mdb
Copy link
Contributor

@amalhotra-mdb amalhotra-mdb commented Apr 8, 2025

DESCRIPTION

Fix incorrect description of VS type in Compass docs.

STAGING

https://deploy-preview-741--docs-compass.netlify.app/indexes/create-vector-search-index/

JIRA

https://jira.mongodb.org/browse/DOCSP-48357

BUILD LOG

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

@netlify
Copy link

netlify bot commented Apr 8, 2025

Deploy Preview for docs-compass ready!

Name Link
🔨 Latest commit d3b122f
🔍 Latest deploy log https://app.netlify.com/sites/docs-compass/deploys/68011681fb8062000868c923
😎 Deploy Preview https://deploy-preview-741--docs-compass.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@jwilson-mdb jwilson-mdb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @amalhotra-mdb. Overall I think removing the table (which has a nested table 😅) and linking to the reference doc makes this section more maintainable long-term.

LGTM mod one requested change (removing "the following") and an optional suggestion.


.. step:: Provide the Atlas Vector Search Index configurations

You must initially provide the following default vector search index
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first sentence in this paragraph mentions "the following". Can we update the wording here to something like:
You must provide all required fields for your vector search index configuration.

Comment on lines 57 to 58
configurations. You can modify the configurations later. To learn more,
see :ref:`avs-types-vector-search-options`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion]
To make the destination content more clear, maybe we can add a bit to the crosslink sentence

Suggested change
configurations. You can modify the configurations later. To learn more,
see :ref:`avs-types-vector-search-options`.
configurations. You can modify the configurations later. For more information on required fields
in vector search index configurations, see :ref:`avs-types-vector-search-options`.

@amalhotra-mdb amalhotra-mdb merged commit fcb6e91 into mongodb:master Apr 17, 2025
5 checks passed
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.

3 participants