Skip to content

feat(docs): source docs from volcano-docs and weight CLI section higher - #134

Merged
tkkhq merged 3 commits into
mainfrom
feat/docs-source-volcano-docs
Jul 29, 2026
Merged

feat(docs): source docs from volcano-docs and weight CLI section higher#134
tkkhq merged 3 commits into
mainfrom
feat/docs-source-volcano-docs

Conversation

@tkkhq

@tkkhq tkkhq commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Tracking

Problem

  • volcano docs sourced only the CLI's own docs/ from the Kong/volcano-cli repo, so search never covered the broader product/platform docs
  • CLI users searching the full corpus need CLI-specific docs to surface first, not get buried under product/platform pages

Summary

  • change the compiled default docs source from Kong/volcano-cli /docs to Kong/volcano-docs /content in internal/docs/source.go
  • add a cliTopicBoost multiplier in internal/docs/search.go so sections in the cli topic (content/cli) rank above equivalent product/platform matches
  • update volcano docs command help and docs/docs-search.md to describe the new default source, the CLI weighting, and --topic cli
  • update fakeDocsServer and the source-envelope assertion to the new repo/path; add TestSearchWeightsCLISectionHigher

Verification

  • go build ./...
  • go vet ./internal/docs/... ./internal/cmd/docs/...
  • go test ./...
  • token-less volcano docs sync --force against the new default: added 121 (public Kong/volcano-docs reachable with no GITHUB_TOKEN); search ranks content/cli sections first and --topic cli filters to them

@tkkhq
tkkhq requested a review from a team as a code owner July 28, 2026 15:46
Copilot AI review requested due to automatic review settings July 28, 2026 15:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 cli topic.
  • 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.

Comment thread internal/docs/search_test.go Outdated
Comment thread internal/cmd/docs/docs.go
Comment thread docs/docs-search.md Outdated
@tkkhq
tkkhq merged commit 936aabd into main Jul 29, 2026
9 checks passed
@tkkhq
tkkhq deleted the feat/docs-source-volcano-docs branch July 29, 2026 20:25
@kong-volcano-app kong-volcano-app Bot mentioned this pull request Jul 29, 2026
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.

2 participants