Skip to content

[docs] Update aspire docs search command documentation for improved relevance #1268

Description

@aspire-repo-bot

Documents changes from microsoft/aspire#18074 by @davidfowl.

Targeting release/13.5 based on the source PR milestone 13.5.

Why this PR is needed

microsoft/aspire#18074 significantly improved the aspire docs search ranking algorithm. Top-1 accuracy on an offline corpus jumped from ~32% to ~87% (MRR 0.387 → 0.896). The key user-facing changes are:

  • Version normalization: queries like whats new 13.5, 13-5, and 135 are all equivalent and find the right What's New page.
  • IDF weighting: Common terms like new or azure count less than specific, discriminating terms.
  • Phrase scoring: Multi-word queries like "service discovery" or "azure container apps environment" rank exact title/slug/heading matches above noisy body mentions.
  • Release-note handling: Explicit queries like whats new 13.5 surface What's New pages; incidental feature mentions no longer dominate results.

The existing aspire docs search reference page described the search only as "keyword-based" with no guidance on phrase queries or version-format normalization, and the What's New 13.5 page had no mention of this improvement.

Changes

Updated pages

  • src/frontend/src/content/docs/reference/cli/commands/aspire-docs-search.mdx

    • Updated description frontmatter to reflect phrase-ranking capability.
    • Rewrote the Description section to describe IDF weighting, version normalization, and phrase/title match scoring.
    • Updated the <query> argument guidance to recommend multi-word phrases and explain version-number formats.
    • Added new examples: "whats new 13.5" (version/release-note query) and phrase queries ("service discovery", "azure container apps environment").
  • src/frontend/src/content/docs/whats-new/aspire-13-5.mdx

    • Added a bullet in the CLI improvements section noting the improved aspire docs search relevance with a link to the reference page.

Generated by PR Documentation Check for issue #18074 · 1.5K AIC · ⌖ 37.1 AIC · ⊞ 45.5K ·


Note

This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download bundle artifact

The bundle file is available in the agent artifact in the workflow run linked above.

To create a pull request with the changes:

# Download the artifact from the workflow run
gh run download 27694922991 -n agent -D /tmp/agent-27694922991

# Fetch the bundle into a temporary ref, then update the local branch
git fetch /tmp/agent-27694922991/aw-microsoft-aspire.dev-docs-improve-search-relevance-13-5.bundle refs/heads/docs/improve-search-relevance-13-5:refs/bundles/create-pr-docs-improve-search-relevance-13-5-364e039bdbb52ede-c50a95eb
git update-ref refs/heads/docs/improve-search-relevance-13-5-364e039bdbb52ede refs/bundles/create-pr-docs-improve-search-relevance-13-5-364e039bdbb52ede-c50a95eb
git checkout docs/improve-search-relevance-13-5-364e039bdbb52ede
# Ensure the working tree matches the updated branch
git reset --hard
# Remove the temporary bundle ref
git update-ref -d refs/bundles/create-pr-docs-improve-search-relevance-13-5-364e039bdbb52ede-c50a95eb

# Push the branch to origin
git push origin docs/improve-search-relevance-13-5-364e039bdbb52ede

# Create the pull request
gh pr create --title '[docs] Update aspire docs search command documentation for improved relevance' --base release/13.5 --head docs/improve-search-relevance-13-5-364e039bdbb52ede --repo microsoft/aspire.dev

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions