[docs] Add --include-hidden option docs to describe, logs, and export commands#723
Merged
JamesNK merged 2 commits intorelease/13.3from Apr 16, 2026
Merged
Conversation
aspire-repo-bot
bot
added
the
docs-from-code
10 tasks
Contributor
|
This needs to go into the 13.3 branch |
JamesNK
approved these changes
Apr 16, 2026
JamesNK
force-pushed
the
docs/cli-include-hidden-option-df51004bcc12cc5f
branch
from
e466dab to
3cd7aae
Compare
Member
Contributor
I attempted to rebase the branch onto
The PR base is already set to |
… docs The describe, logs, and export commands now hide resources marked as hidden by default, with a new --include-hidden option to reveal them. Update the three command reference pages and add a shared include file for the new option. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JamesNK
force-pushed
the
docs/cli-include-hidden-option-df51004bcc12cc5f
branch
from
75fd8b1 to
e6ae9d0
Compare
JamesNK
reviewed
Apr 16, 2026
Copilot AI
pushed a commit
that referenced
this pull request
Apr 16, 2026
… commands (#723) 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: James Newton-King <james@newtonking.com> Co-authored-by: IEvangelist <7679720+IEvangelist@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.
Documents changes from microsoft/aspire#16146 by @JamesNK.
Why this PR is needed
The Aspire CLI
describe,logs, andexportcommands now hide resources marked as hidden by default (consistent with how the Aspire Dashboard displays them). A new--include-hiddenoption lets users explicitly reveal hidden resources. The existing documentation did not mention this behavior or the new option.Changes summary
aspire-describe.mdx: Updated description to mention hidden resources are excluded by default; added--include-hiddenoption to the Options section; added an example.aspire-logs.mdx: Updated description to mention hidden resources are excluded by default; added--include-hiddenoption to the Options section; added an example.aspire-export.mdx: Updated description to mention hidden resources are excluded by default; added--include-hiddenoption to the Options section; added an example.includes/option-include-hidden.md(new): Shared include file for the--include-hiddenoption, reused across all three command pages.Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-describe.mdx— updatedsrc/frontend/src/content/docs/reference/cli/commands/aspire-logs.mdx— updatedsrc/frontend/src/content/docs/reference/cli/commands/aspire-export.mdx— updatedsrc/frontend/src/content/docs/reference/cli/includes/option-include-hidden.md— newNote
This is a draft PR and needs human review before merging.