[docs] Document aspire render debug command and links scenario#970
Closed
aspire-repo-bot[bot] wants to merge 1 commit into
Closed
[docs] Document aspire render debug command and links scenario#970aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
…oft/aspire#17106) Add reference documentation for the hidden aspire render debug command and document the new 'links' scenario added in microsoft/aspire#17106, which allows CLI contributors to smoke test terminal hyperlink rendering (SafeLink and SafeFileLink) without needing a full AppHost. Also add a brief mention of the links scenario to the What's new in Aspire 13.4 release notes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 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
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.
Documents changes from microsoft/aspire#17106
Author:
@JamesNKTarget branch
Targeting
release/13.4based on the source PR milestone13.4(exact match onmicrosoft/aspire.dev).Why this PR is needed
microsoft/aspire#17106 modified
src/Aspire.Cli/Commands/RenderCommand.cs(triggeringcli_command_file_changed) and includes a### User-facing usagesection and--scenario linksflag mention (pr_body_has_user_facing_section,pr_body_has_cli_flag_mention). Theaspire rendercommand had no prior documentation onaspire.dev.The change adds a
linksscenario to the hidden, debug-onlyaspire rendercommand. This scenario allows CLI contributors to smoke test terminal hyperlink rendering — bothMarkupHelpers.SafeLink(clickable URLs) andMarkupHelpers.SafeFileLink(clickable file-system paths, including paths with spaces).Documentation changes
src/frontend/src/content/docs/reference/cli/commands/aspire-render.mdxaspire renderdebug command with a prominent caution note that it is for CLI contributors/maintainers onlylinksscenariolinksscenariosrc/frontend/src/content/docs/whats-new/aspire-13-4.mdxlinksscenario for theaspire renderdebug commandNote
The
aspire rendercommand is hidden from end users and only available in debug builds. The SME reviewer should confirm whether this reference page is appropriate for the public docs site, or whether it should be closed as an internal-only change.