Skip to content

[docs] Document ResourceUrlAnnotation.DisplayOrder - #1806

Draft
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20637-36907046381-1-b78cdcefa763aa07
Draft

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20637-36907046381-1-b78cdcefa763aa07

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20637

@eerhardt

Target branch

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

Why this is needed

microsoft/aspire#20637 makes ResourceUrlAnnotation.DisplayOrder a non-obsolete, nullable read/write int property (previously an obsolete field), allowing consumers to control the sort order of custom resource URLs in the dashboard without obsolete warnings. Higher values sort higher in the dashboard. This is a user-facing API change with a documented "User-facing usage" example in the source PR, and no existing page on aspire.dev mentioned DisplayOrder, so a docs update was needed.

What changed

  • Added a new "Control URL display order" subsection to fundamentals/custom-resource-urls.mdx, right after the existing "Customize endpoint URL" section, explaining the DisplayOrder property and showing a WithUrlForEndpoint example setting url.DisplayOrder = 1000; (mirroring the source PR's example).

Files modified

  • src/frontend/src/content/docs/fundamentals/custom-resource-urls.mdx (updated — existing page, no new pages created)

Generated by PR Documentation Check for #20637 · copilot · auto · 43 AIC · ⌖ 12.8 AIC · ⊞ 20.3K · ◷

Documents changes from microsoft/aspire#20637

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Oct 1, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1806. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1806 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants