Skip to content

[docs] Document aspire doctor check timeouts - #1472

Merged
James Newton-King (JamesNK) merged 4 commits into
release/13.5from
docs/pr-18969-31547817649-1-ed94324e18d00c7a
Aug 13, 2026
Merged

[docs] Document aspire doctor check timeouts#1472
James Newton-King (JamesNK) merged 4 commits into
release/13.5from
docs/pr-18969-31547817649-1-ed94324e18d00c7a

Conversation

@aspire-repo-bot

@aspire-repo-bot aspire-repo-bot Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#18969

@JamesNK

Targeting release/13.5 based on the source PR milestone 13.5.

Why

aspire doctor could previously hang at Checking Aspire environment... indefinitely if an environment check or installation discovery blocked.

What changed

Updated src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx with 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 the aspire doctor result includes a warning when a timeout occurs.

No new pages were created; this is an update to the existing aspire doctor command reference page.

Generated by PR Documentation Check · auto · 58.8 AIC · ⌖ 7.15 AIC · ⊞ 19.6K ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Aug 11, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1472. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1472 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779

@adamint Adam Ratzman (adamint) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the timeout values, cancellation behavior, warning output, and JSON metadata against the CLI implementation. This looks good.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the updated timeout note. The per-check, aggregate, and installation-discovery limits are concise and unambiguous, and the warning behavior is stated clearly.

@JamesNK
James Newton-King (JamesNK) merged commit c7375b6 into release/13.5 Aug 13, 2026
10 checks passed
@JamesNK
James Newton-King (JamesNK) deleted the docs/pr-18969-31547817649-1-ed94324e18d00c7a branch August 13, 2026 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants