Skip to content

Conversation

kosabogi
Copy link
Contributor

@kosabogi kosabogi commented Aug 14, 2025

⚠️ DO NOT MERGE BEFORE elastic/elasticsearch#133066

📸 Preview

This PR introduces a new section on Better Binary Quantization (BBQ) in the Reference documentation.

In this PR, I've added a link to that newly added page.

Related issue: https://github.com/elastic/developer-docs-team/issues/333

@kosabogi kosabogi requested a review from szabosteve August 14, 2025 12:17
@kosabogi kosabogi requested a review from a team as a code owner August 14, 2025 12:17
Copy link

github-actions bot commented Aug 14, 2025

🔍 Preview links for changed docs

@kosabogi kosabogi requested a review from carlosdelest August 14, 2025 12:40
Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

I am not very familiar with the topic, but this is looking readable and clear. Left a few suggestions for your consideration, hope they are helpful!

Copy link
Contributor

@john-wagster john-wagster left a comment

Choose a reason for hiding this comment

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

I left a few suggestions to primarily add clarity or add some gravity to certain parts of the docs, which I think can help with instilling confidence in folks who read them. Particularly worth clarifying that BBQ is default only for vectors >384 dims. Please feel free to take or leave any of it. If you have questions or concerns about BBQ or the comments I suggested don't hesitate to ask. In general the docs look good to me and I really appreciate you putting them together. thanks! lgtm

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

This looks great, my only concern is about splitting reference content between the "solution/use case" docs and the ES reference docs, I think most folks would prefer everything in one place.

So my one ask would be to question whether this content shouldn't live in the ES reference. I think we need to rethink how we approach this entire solution/use case section TBH.

If we're happy to have it here, we'll need to richly link from the ES reference to this content at the very least. :)

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

The content and the structure look great! Nice work!
Agree that it should live in ES reference, specifically under Index settings from the top of my head. We should add cross-links to this dense vector page that point to the reference material.

@kosabogi kosabogi changed the title Adds a new section about BBQ to the 'Dense vector' page Adds a small section and navigation link to BBQ documentation on the 'Dense vector' page Aug 18, 2025
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

Thank you for the changes! LGTM!

@kosabogi kosabogi merged commit e1dda62 into main Aug 18, 2025
7 checks passed
@kosabogi kosabogi deleted the bbq-documentation branch August 18, 2025 12:52
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.

5 participants