Update standalone dashboard docs for Aspire CLI#886
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Aspire Dashboard documentation to make /dashboard/standalone/ the primary “source of truth” for running the dashboard standalone, emphasizing the aspire dashboard run workflow while keeping the container image as an alternative path.
Changes:
- Reworked the standalone dashboard guide to present two supported startup options (Aspire CLI first, container image second) and adjusted related login/auth guidance.
- Removed repeated Docker startup command blocks from the dashboard landing/overview and language-specific guides, replacing them with links back to the standalone guide.
- Updated language guides (Python, Node.js) to focus on telemetry setup rather than duplicating dashboard startup instructions.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/dashboard/standalone.mdx | Repositions the page as the canonical standalone startup guide, documenting CLI + container image workflows. |
| src/frontend/src/content/docs/dashboard/standalone-for-python.mdx | Removes embedded Docker startup instructions and links to the standalone guide instead. |
| src/frontend/src/content/docs/dashboard/standalone-for-nodejs.mdx | Removes embedded Docker startup instructions and links to the standalone guide instead; trims unused imports. |
| src/frontend/src/content/docs/dashboard/overview.mdx | Collapses standalone section to a short description linking to the standalone guide; removes Docker command block. |
| src/frontend/src/content/docs/dashboard/index.mdx | Collapses standalone run section to a short description linking to the standalone guide; removes Docker command block and updates capability text. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (1)
src/frontend/src/content/docs/dashboard/standalone-for-python.mdx:231
- The shutdown instruction assumes the dashboard is running in the foreground (Ctrl+C), which is true for
aspire dashboard runbut not for the container-image workflow (the standalone guide runs the container detached). Please split the instruction by startup method (e.g., Ctrl+C for CLI,docker stop aspire-dashboardfor container) so readers can reliably stop the dashboard.
<Steps>
1. Stop the FastAPI application by pressing <Kbd windows='Ctrl+C' mac='⌘+C' /> in the terminal where it's running.
2. Stop the Aspire dashboard by pressing <Kbd windows='Ctrl+C' mac='⌘+C' /> in the terminal where the dashboard is running.
- Files reviewed: 5/5 changed files
- Comments generated: 1
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JamesNK
reviewed
May 8, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JamesNK
reviewed
May 8, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
IEvangelist
approved these changes
May 8, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
davidfowl
added a commit
that referenced
this pull request
May 8, 2026
* chore: Update integration data and GitHub stats (5/7/26) (#882) Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Use pnpm instead of npm in check-data-files.mjs (#881) The repository is configured as a pnpm workspace (pnpm-workspace.yaml, pnpm-lock.yaml, packageManager: pnpm@10.30.1), but check-data-files.mjs hardcoded `npm run update:all`. Running npm inside a pnpm workspace ignores pnpm-lock.yaml, creates an unnecessary package-lock.json, and can corrupt or destabilize the local development environment. Fixes #872 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: Update integration data and GitHub stats (5/8/26) (#890) Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Hot Reload and watch guidance (#887) * Add Hot Reload and watch guidance Document Aspire watch behavior for AppHost changes, resource-specific restart and rebuild workflows, and IDE-managed hot reload/debugging boundaries. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clarify dotnet watch AppHost behavior Document current dotnet watch behavior for Aspire AppHosts and .NET project resources, including restart behavior and known quirks requiring explicit restart or rebuild commands. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clarify C# projects watch guidance Rename the project resources tab to C# projects and tighten the dotnet watch wording around C# project behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Refine C# dotnet watch guidance Lead the C# projects section with dotnet watch support for C# AppHosts and move current experience quirks into an Important note. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Reduce C# watch guidance repetition Tighten the C# projects section so dotnet watch support and defaultWatchEnabled behavior are not repeated. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update standalone dashboard docs for Aspire CLI (#886) * Update standalone dashboard docs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Centralize standalone dashboard prerequisites Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Restore dashboard landing quick start Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address dashboard quick start feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix terminal tabs regression test source Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix standalone dashboard telemetry limits link Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Show both dashboard quick start options Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address standalone dashboard review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
Copilot AI
pushed a commit
that referenced
this pull request
May 9, 2026
* chore: Update integration data and GitHub stats (5/7/26) (#882) Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Use pnpm instead of npm in check-data-files.mjs (#881) The repository is configured as a pnpm workspace (pnpm-workspace.yaml, pnpm-lock.yaml, packageManager: pnpm@10.30.1), but check-data-files.mjs hardcoded `npm run update:all`. Running npm inside a pnpm workspace ignores pnpm-lock.yaml, creates an unnecessary package-lock.json, and can corrupt or destabilize the local development environment. Fixes #872 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: Update integration data and GitHub stats (5/8/26) (#890) Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Hot Reload and watch guidance (#887) * Add Hot Reload and watch guidance Document Aspire watch behavior for AppHost changes, resource-specific restart and rebuild workflows, and IDE-managed hot reload/debugging boundaries. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clarify dotnet watch AppHost behavior Document current dotnet watch behavior for Aspire AppHosts and .NET project resources, including restart behavior and known quirks requiring explicit restart or rebuild commands. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clarify C# projects watch guidance Rename the project resources tab to C# projects and tighten the dotnet watch wording around C# project behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Refine C# dotnet watch guidance Lead the C# projects section with dotnet watch support for C# AppHosts and move current experience quirks into an Important note. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Reduce C# watch guidance repetition Tighten the C# projects section so dotnet watch support and defaultWatchEnabled behavior are not repeated. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update standalone dashboard docs for Aspire CLI (#886) * Update standalone dashboard docs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Centralize standalone dashboard prerequisites Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Restore dashboard landing quick start Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address dashboard quick start feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix terminal tabs regression test source Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix standalone dashboard telemetry limits link Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Show both dashboard quick start options Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address standalone dashboard review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
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.
The standalone dashboard docs still emphasized the container-image workflow in several entry points, which made the new
aspire dashboard runpath less discoverable. This updates the docs to recommend installing the Aspire CLI for the primary standalone workflow while preserving the container image as the second supported way to run the dashboard.Summary
/dashboard/standalone/the source of truth for starting the standalone dashboard.Validation
/dashboard/standalone/contains theaspire dashboard runanddocker run --rmexamples.git diff --check.