[docs] Document dashboard run Ctrl+C stop message - #1445
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
David Pine (IEvangelist)
left a comment
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
Validated against microsoft/aspire#18827. The note accurately documents Ctrl+C shutdown and the corrected single Stopping dashboard. message.
There was a problem hiding this comment.
Pull request overview
This PR updates the aspire dashboard run CLI reference page to document how to stop the dashboard with Ctrl+C and what shutdown output to expect, aligning the docs with the CLI behavior change referenced from microsoft/aspire#18827.
Changes:
- Adds a note stating that pressing Ctrl+C stops the dashboard.
- Documents that the CLI prints a single
Stopping dashboard.message when shutdown is initiated.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Any additional arguments not recognized by the CLI are forwarded directly to the dashboard process, allowing you to pass dashboard configuration settings (for example, `--Dashboard:TelemetryLimits:MaxLogCount=5000`). | ||
|
|
||
| To stop the dashboard, press <kbd>Ctrl+C</kbd> in the terminal where it's running. The CLI prints a single `Stopping dashboard.` message when shutdown is initiated. |
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Documents changes from microsoft/aspire#18827
@JamesNKTargeting
release/13.5based on the source PR milestone13.5(exact match).Why
microsoft/aspire#18827 fixed a duplicate shutdown message shown when stopping
aspire dashboard runwith Ctrl+C. Previously the CLI printed both a dashboard-specific message and a generic "Stopping Aspire." message; now it emits a singleStopping dashboard.line. Theaspire-dashboard-runreference page didn't mention how to stop the dashboard or what output to expect, so this adds a short note.Changes
src/frontend/src/content/docs/reference/cli/commands/aspire-dashboard-run.mdx: Added a sentence describing that pressing Ctrl+C stops the dashboard and prints a singleStopping dashboard.message.No new pages were created; only the existing command reference page was updated.