Skip to content

Update standalone dashboard docs for Aspire CLI#886

Merged
davidfowl merged 8 commits intomainfrom
davidfowl/standalone-dashboard-docs
May 8, 2026
Merged

Update standalone dashboard docs for Aspire CLI#886
davidfowl merged 8 commits intomainfrom
davidfowl/standalone-dashboard-docs

Conversation

@davidfowl
Copy link
Copy Markdown
Contributor

The standalone dashboard docs still emphasized the container-image workflow in several entry points, which made the new aspire dashboard run path 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

  • Make /dashboard/standalone/ the source of truth for starting the standalone dashboard.
  • Document both supported startup paths there: Aspire CLI and standalone container image.
  • Trim repeated startup commands from the dashboard landing, overview, Python, and Node.js pages and link them back to the standalone guide.
  • Keep the language guides focused on app telemetry setup instead of repeating dashboard startup details.

Validation

  • Validated the affected pages against the running local Aspire app.
  • Confirmed only /dashboard/standalone/ contains the aspire dashboard run and docker run --rm examples.
  • Confirmed the other affected pages link back to the standalone guide.
  • Ran git diff --check.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 8, 2026 03:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 run but 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-dashboard for 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

Comment thread src/frontend/src/content/docs/dashboard/standalone-for-python.mdx
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Comment thread src/frontend/src/content/docs/dashboard/index.mdx
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Comment thread src/frontend/src/content/docs/dashboard/index.mdx
davidfowl and others added 3 commits May 7, 2026 23:32
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>
Copy link
Copy Markdown
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

Comment thread src/frontend/src/content/docs/dashboard/standalone.mdx
Comment thread src/frontend/tests/e2e/ui-regressions.spec.ts
davidfowl and others added 2 commits May 8, 2026 08:38
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@davidfowl davidfowl merged commit 8eaf4c6 into main May 8, 2026
5 checks passed
@davidfowl davidfowl deleted the davidfowl/standalone-dashboard-docs branch May 8, 2026 17:14
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants