WIP - Restructuring vector search docs and adding vector landing page and conceptual page#5567
Open
WIP - Restructuring vector search docs and adding vector landing page and conceptual page#5567
Conversation
Contributor
Vale Linting ResultsSummary: 3 warnings, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/search/vector.md | 72 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
| solutions/search/vector.md | 109 | Elastic.Spelling | 'Cohere's' is a possible misspelling. |
| solutions/search/vector/how-vector-search-works.md | 47 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
💡 Suggestions (1)
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/search/vector.md | 21 | Elastic.WordChoice | Consider using 'efficient' instead of 'easy', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
Contributor
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.
👀 💬 Draft PR - seeking your feedback. This is a proposal for collaboration. The changes are open to discussion and revision.
Vector search documentation restructure
Summary of changes
What was done
Added a vector search landing page (
solutions/search/vector.md): A dedicated entry point for vector search (use cases, workflows, collection of resources)Added a concepts page (
solutions/search/vector/how-vector-search-works.md): A terminology and concepts page covering important terminology (like vector embeddings, embedding models, dimensions), quantization, querying.Restructured the information architecture:
Updated cross-links across search docs to reflect the new structure (e.g.,
search-approaches.md,semantic-search.md,hybrid-search.md,get-started/semantic-search.md).Main decisions and reasoning
I did research to inform these decisions. Here you can check the research and the key takeaways: search term analysis and semantic/vector relationship.
Remove the AI-powered search umbrella category. "AI-powered search" is nowadays more associated with LLMs, chat interfaces, and generative AI features. "Vector search" and "semantic search" better describe the underlying technical capability and align with user expectations.
Treat semantic search as part of vector search. Logically clearer: vector search is the foundation; semantic search is a workflow built on it.
Reviewer focus: first round
For this first review, please focus on structure and naming, not detailed content. We can do deeper content review in a follow-up round once the structure is agreed.
What to review
Overall structure
Naming changes
Vector search landing page (
vector.md)How vector search works (
vector/how-vector-search-works.md)Out of scope for this round
Once structure and naming are confirmed, we can proceed with a content-focused review.