[docs] Document aspire render debug command and links scenario#1358
[docs] Document aspire render debug command and links scenario#1358IEvangelist wants to merge 1 commit into
Conversation
IEvangelist
added
the
docs-from-code
There was a problem hiding this comment.
Pull request overview
Adds public documentation for the hidden, debug-only aspire render CLI command (including the new links scenario) and mentions the scenario in the Aspire 13.4 release notes.
Changes:
- Added a new CLI reference page for
aspire render, including scenarios and an example for--scenario links. - Updated the Aspire 13.4 “What’s new” page to note the new
linksscenario.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/reference/cli/commands/aspire-render.mdx | New reference page documenting the hidden aspire render debug command and scenarios. |
| src/frontend/src/content/docs/whats-new/aspire-13-4.mdx | Adds a release-note bullet for the new links scenario. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **`--scenario <scenario>`** | ||
|
|
||
| Run a specific rendering scenario non-interactively and exit. If omitted, the command | ||
| enters the interactive scenario selector. | ||
|
|
||
| - **`--console-width <width>`** | ||
|
|
||
| Override the detected console width used when rendering. Useful for testing how output | ||
| wraps at specific widths. |
|
|
||
| ## Scenarios | ||
|
|
||
| The following rendering scenarios are available in debug builds: |
| ## Synopsis | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire render [--scenario <scenario>] [--console-width <width>] |
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
|
|
CI has been retriggered multiple times and is still failing on the current PR head. This looks likely to be caused by changes in this PR rather than transient infra flakiness. |
CI Failure: Missing Topic Entry for \�spire-render\ CLI Reference PageThe frontend build is failing with: \ The PR adds a new CLI reference page at Please add the appropriate topic entry for the \�spire render\ CLI reference page to fix this CI failure. |
|
CI has already been retriggered multiple times (latest attempt: 4) and is still failing on Frontend Build. This appears to be caused by the current PR changes rather than a transient runner issue, so this PR likely needs an update before another rerun. |
|
CI has been retriggered several times and is still failing due to changes in this PR. This likely needs PR-content fixes before CI will pass consistently. |
|
[docs-from-code-automation] repeated CI failure note posted CI has been retriggered multiple times for this PR and the failures continue on the same changeset. This likely needs a PR-side fix rather than another rerun. |
|
We've retriggered CI multiple times (latest run attempt: 15), and it's still failing in CI (frontend-build / Frontend Build, ci-gate). The repeated failure is in frontend build/ci-gate, which appears to be introduced by this PR changeset. Could someone update this PR to address the failing check directly? |
|
CI has been retriggered multiple times and appears to be failing due to changes in this PR. Please review the failing jobs and address the PR changes causing the failures. |
|
CI has been retriggered multiple times and is still failing on this PR. This likely requires changes in the PR content rather than another rerun. |
|
We've retriggered CI multiple times on this PR, and failures have persisted. This appears to be caused by the current PR changes rather than a transient CI issue, so this PR likely needs an update to resolve the failing checks. |
Supersedes #970.
This replacement targets
elease/13.5 because the original
elease/13.4 base branch no longer exists on microsoft/aspire.dev.
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.