Skip to content

Document WithDisplayOrder and consolidate dashboard explore fixes - #2105

Merged
Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21766-42886203726-1-51874edbd7f217d8
Nov 13, 2026
Merged

Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21766-42886203726-1-51874edbd7f217d8

Conversation

@aspire-repo-bot

@aspire-repo-bot aspire-repo-bot Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#21766

Author: @sebastienros

Target branch: Targeting release/17.0 — the latest release branch on microsoft/aspire.dev — because the source PR has no milestone or release/* base ref to derive a more specific target.

Why: The source PR replaces WithDashboardPosition with the new WithDisplayOrder API (backed by DisplayOrderAnnotation), which controls resource ordering in the dashboard. Triggered signals: new_public_type (DisplayOrderAnnotation.cs) and dashboard_user_facing_page_changed (ResourceOverview.razor, TraceDetail.razor).

Changes: Updated existing page src/frontend/src/content/docs/dashboard/explore.mdx with a "Resource display order" section describing WithDisplayOrder semantics (higher values first, unset counts as 0) and an example.

Generated by PR Documentation Check for #21766 · copilot · auto · 31.5 AIC · ⌖ 1.16 AIC · ⊞ 7.4K · ◷


Review update: This PR now also consolidates the still-accurate parts of #2045 and #2066, which edited the same page:

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 Nov 10, 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 #2105. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #2105 artifacts

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The WithDisplayOrder example will not compile without the required experimental-API suppression, and the documentation omits that persisted manual ordering overrides its default order.

2 open issues
What changed in this PR

Adds WithDisplayOrder guidance to the dashboard exploration guide for Aspire 17.0, documenting the replacement for WithDashboardPosition.

Changes:

  • Explains that higher display-order values appear first and unset values count as zero.
  • Adds a C# AppHost example ordering API and worker resources.
File Description
src/​frontend/​src/​content/​docs/​dashboard/​explore.mdx Adds a resource display-order section with ordering semantics and an example.

Review effort: Balanced


### Resource display order

By default, the dashboard sorts resources by name. To control where a resource appears, call `WithDisplayOrder` in the AppHost. It's a relative sort key: resources with a higher value appear first, and resources without a value count as `0`.
Comment on lines +336 to +337
```csharp title="C# — AppHost.cs"
var builder = DistributedApplication.CreateBuilder(args);
- Default order is by type then name; saved order wins; negative values
- Add TypeScript sample and note the ASPIRERESOURCETRAITS001 experimental flag
- Move the section next to Filter and group resources
- Fold in contextual resource actions from #2045
- Fold in Aspire Outage Hard core mode and O shortcut from #2066
@sebastienros Sébastien Ros (sebastienros) changed the title [docs] Document WithDisplayOrder for dashboard resources Document WithDisplayOrder and consolidate dashboard explore fixes Nov 13, 2026
The unknown-arguments example ran 'aspire destroy --force' in a bash block,
which the pipeline command options unit test flags as an undocumented option.
Describe the invalid option in prose and keep the error output.
@sebastienros
Sébastien Ros (sebastienros) merged commit 9615d4d into release/17.0 Nov 13, 2026
16 checks passed
@sebastienros
Sébastien Ros (sebastienros) deleted the docs/pr-21766-42886203726-1-51874edbd7f217d8 branch November 13, 2026 23:59
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.

2 participants