[docs] Document aspire doctor check timeouts - #1472
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
There was a problem hiding this comment.
Pull request overview
Updates the aspire doctor command reference to document newly introduced timeouts and how they surface in table and JSON output, aligning aspire.dev docs with the behavior added in microsoft/aspire#18969.
Changes:
- Added a note describing per-check, aggregate, and installation-discovery timeouts plus process-tree cancellation behavior.
- Added sample table output for individual-check and aggregate timeout warnings.
- Added JSON output example/notes for timeout metadata (
checkType,timeoutSeconds).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779
Adam Ratzman (adamint)
left a comment
There was a problem hiding this comment.
I checked the timeout values, cancellation behavior, warning output, and JSON metadata against the CLI implementation. This looks good.
James Newton-King (JamesNK)
left a comment
There was a problem hiding this comment.
Reviewed the updated timeout note. The per-check, aggregate, and installation-discovery limits are concise and unambiguous, and the warning behavior is stated clearly.
Documents changes from microsoft/aspire#18969
@JamesNKTargeting
release/13.5based on the source PR milestone13.5.Why
aspire doctorcould previously hang atChecking Aspire environment...indefinitely if an environment check or installation discovery blocked.What changed
Updated
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdxwith a note explaining the 30-second per-check timeout, the two-minute aggregate timeout, and the separate 30-second installation-discovery timeout. The note also explains that theaspire doctorresult includes a warning when a timeout occurs.No new pages were created; this is an update to the existing
aspire doctorcommand reference page.