feat(docs): source docs from volcano-docs and weight CLI section higher - #134
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates documentation search to use the full private Volcano docs corpus and prioritize CLI content.
Changes:
- Changes the default source to
Kong/volcano-docs/content. - Adds a 1.5× ranking boost for the
clitopic. - Updates tests, command help, and user documentation.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
internal/docs/source.go |
Changes the compiled default docs source. |
internal/docs/search.go |
Adds CLI-topic score boosting. |
internal/docs/search_test.go |
Tests CLI ranking behavior. |
internal/cmd/docs/docs.go |
Updates command help for the new source. |
internal/cmd/docs/docs_test.go |
Updates the fake source and assertions. |
docs/docs-search.md |
Documents source configuration and ranking. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Merged
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.
Tracking
Problem
volcano docssourced only the CLI's owndocs/from theKong/volcano-clirepo, so search never covered the broader product/platform docsSummary
Kong/volcano-cli/docstoKong/volcano-docs/contentininternal/docs/source.gocliTopicBoostmultiplier ininternal/docs/search.goso sections in theclitopic (content/cli) rank above equivalent product/platform matchesvolcano docscommand help anddocs/docs-search.mdto describe the new default source, the CLI weighting, and--topic clifakeDocsServerand the source-envelope assertion to the new repo/path; addTestSearchWeightsCLISectionHigherVerification
go build ./...go vet ./internal/docs/... ./internal/cmd/docs/...go test ./...volcano docs sync --forceagainst the new default:added 121(publicKong/volcano-docsreachable with noGITHUB_TOKEN); search rankscontent/clisections first and--topic clifilters to them