[docs] Add --list-steps sample output to aspire do and pipelines pages#847
Merged
mitchdenny merged 1 commit intorelease/13.3from May 6, 2026
Merged
Conversation
The reference docs for aspire do and the deployment/pipelines conceptual page already document the --list-steps flag, but neither shows what the output actually looks like. Add a short, canonical numbered-tree sample (matches the formatter in microsoft/aspire#16085 and its snapshot tests) so readers can see at a glance what to expect — including the connectors used for steps with deps only, deps and tags, and steps with no dependencies. Context: #837 (item #2), follow-up polish to #801. Co-authored-by: Copilot <223556219+Copilot@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
1 participant
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.
Adds a short example output block for the
--list-stepsflag to the two pages where it gets the most attention:src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx— in the existing Quick listing with--list-stepssubsection.src/frontend/src/content/docs/deployment/pipelines.mdx— in the existing Discovering available steps subsection underaspire do.The sample matches the actual formatter introduced in microsoft/aspire#16085 (verified against
PipelineCommandBase.PrintPipelineStepsandPipelineCommandListStepsTests.cs) so the page accurately reflects what users see in the terminal — including the├─/└─connectors used for steps with deps only, deps and tags, or no dependencies at all.This is a small follow-up polish on top of #801 (which originally documented
--list-steps) and closes out item #2 of #837.Validation
pnpm --dir ./src/frontend run lint— cleanpnpm --dir ./src/frontend run test:unit:docs— 2/2 passedNotes
release/13.3because--list-stepsshipped in 13.3 and the existing--list-stepsdocumentation lives there.aspire-13-3.mdxwas pushed to [whats-new] Expand 13.3 release notes #838.