Restructures kNN documentation into a clearer page hierarchy#7138
Open
kosabogi wants to merge 8 commits into
Open
Restructures kNN documentation into a clearer page hierarchy#7138kosabogi wants to merge 8 commits into
kosabogi wants to merge 8 commits into
Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: One grammar error (missing "you") in
optimize-performance-accuracy.mdline 209. First-person "we" in two new files (exact-knn.mdandbuild-search-queries.md). Both are introduced by this PR. - Jargon: No unexplained jargon found in the new pages.
HNSW,DiskBBQ,bbq_diskare explained in context. - Frontmatter and applies_to: High-priority:
approximate-knn.mdduplicates themapped_pagesalready present onknn.md. Duplicatemapped_pagesentries for the same legacy URLs across two files will cause a build conflict. See inline comment onapproximate-knn.mdline 6. - Content type fit: The four new pages are correctly structured as how-to guides. One structural issue:
exact-knn.mdhas the kNN definition and use cases stranded after the 3-step procedure (lines 83–93), which reads as orphaned content from the original page. See inline comment. - Parent issue satisfaction: The PR satisfies the restructuring goal described in the PR body. The hierarchy is clear and content is sensibly split. Inline issues are in the details of execution, not the overall approach.
Nits
exact-knn.mdline 92: "Check out our [hands-on tutorial]" uses first-person "our". Consider: "For a hands-on example, refer to Bring your own dense vectors."build-search-queries.mdline 485: Field names"paragraphs"and"metadata"are wrapped in prose double quotes; prefer backtick monospace:`paragraphs`and`metadata`.
Notes
- The Vale finding at
optimize-performance-accuracy.mdline 219 ("Use 'and later' instead of 'and higher'") is a false positive — the text refers to compression levels, not version numbers. - Pre-existing style findings in unchanged files (
cross-cluster-search.md,ml-nlp-model-ref.md, etc.) are out of scope for this review.
Generated by Docs review agent for issue #7138 · 78.4 AIC · ⌖ 10.8 AIC · ⊞ 10.7K
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 3 warnings, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/search/vector/knn/build-search-queries.md | 63 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| solutions/search/vector/knn/optimize-performance-accuracy.md | 257 | Elastic.Spelling | 'rescored' is a possible misspelling. |
| solutions/search/vector/knn/optimize-performance-accuracy.md | 258 | Elastic.Spelling | 'rescored' is a possible misspelling. |
💡 Suggestions (2): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/search/vector/knn/build-search-queries.md | 141 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| solutions/search/vector/knn/optimize-performance-accuracy.md | 218 | Elastic.Versions | Use 'and later' instead of 'and higher' when referring to versions. |
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.
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.
This PR split the kNN search kNN search on Elasticsearch page into a nested structure.
Related issue: #1740
Parent issue: https://github.com/elastic/docs-content-internal/issues/801