[docs] Document Console/Terminal view toggle for WithTerminal resources - #1438
Merged
David Pine (IEvangelist) merged 1 commit intoAug 7, 2026
Conversation
aspire-repo-bot
Bot
added
the
docs-from-code
David Pine (IEvangelist)
marked this pull request as ready for review
August 7, 2026 05:16
David Pine (IEvangelist)
approved these changes
Aug 7, 2026
David Pine (IEvangelist)
left a comment
David Pine (IEvangelist)
left a comment
Member
There was a problem hiding this comment.
Validated against microsoft/aspire#18574. The Console logs/Terminal selector, default view, resource-switch reset, and dual-view lifetime behavior are documented accurately.
David Pine (IEvangelist)
enabled auto-merge (squash)
August 7, 2026 05:17
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the WithTerminal documentation to reflect the new Aspire Dashboard Console logs / Terminal view toggle behavior on the Console Logs page, replacing the previously documented “terminal replaces console logs” behavior.
Changes:
- Rewrites the “View terminals in the dashboard” section to describe the new view-toggle UI (Console logs vs Terminal).
- Adds guidance about view switching behavior and an Aside clarifying that the toggle affects display only, not capture/streaming.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| When a resource has `WithTerminal` applied, its **Console Logs** tab in the [Aspire dashboard](/dashboard/overview/) is replaced by a live terminal session. You can drive the running process directly in the browser without leaving the dashboard. For example, you can type commands, scroll the scrollback buffer, and switch between replicas. Each replica appears as its own entry (for example, `agent-r0`, `agent-r1`, `agent-r2`) with an independent session. | ||
| When a resource has `WithTerminal` applied, its **Console Logs** page in the [Aspire dashboard](/dashboard/overview/) gains a live terminal session alongside the usual console log stream. You can drive the running process directly in the browser without leaving the dashboard. For example, you can type commands, scroll the scrollback buffer, and switch between replicas. Each replica appears as its own entry (for example, `agent-r0`, `agent-r1`, `agent-r2`) with an independent session. | ||
|
|
||
| The page defaults to the **Console logs** view so that hosting messages—such as "Waiting for resource X to become healthy..." or a startup failure—are visible immediately, even before the terminal's PTY has attached. Open the toolbar's options (⋯) menu and choose **Terminal** to switch to the interactive terminal view, or choose **Console logs** to switch back. Both views stay live while you're on the page: switching between them never tears down the terminal session or loses console log scrollback, and selecting a different resource resets the page back to the **Console logs** view. |
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
David Pine (IEvangelist)
deleted the
docs/console-terminal-toggle-18574-6dba8bc63547214a
branch
August 7, 2026 05:45
50 tasks
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.
Documents changes from microsoft/aspire#18574
@IEvangelistTargeting
release/13.5based on the source PR milestone13.5.Why this is needed
PR 18574 changed the dashboard's
ConsoleLogspage (src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor/.razor.cs) so that resources usingWithTerminal()no longer have their Console Logs tab wholesale replaced by the terminal view. Instead, the page adds a newConsoleLogsViewenum (Console logs / Terminal) with a toolbar (⋯) menu toggle, defaults to Console logs so pre-PTY hosting messages are visible, and keeps both views mounted so switching never tears down either session.This is a
dashboard_user_facing_page_changed+new_public_typesignal from the docs-check pipeline, and the existing docs (app-host/with-terminal.mdx, "View terminals in the dashboard" section) described the old behavior — the terminal outright replacing the Console Logs tab — which is now incorrect.What changed
Updated
src/frontend/src/content/docs/app-host/with-terminal.mdx:Asideclarifying that view selection doesn't affect what's captured, only what's displayed.No new pages were created; this is a targeted update to an existing page.