Skip to content

Add aspire doctor CLI reference documentation#270

Merged
IEvangelist merged 3 commits intomainfrom
copilot/add-cli-reference-for-doctor
Jan 26, 2026
Merged

Add aspire doctor CLI reference documentation#270
IEvangelist merged 3 commits intomainfrom
copilot/add-cli-reference-for-doctor

Conversation

Copy link
Contributor

Copilot AI commented Jan 21, 2026

  • Create aspire-doctor.mdx CLI reference documentation file based on DoctorCommand.cs from the Aspire repo
  • Add aspire doctor command entry to the main aspire.mdx commands table
  • Add aspire doctor to the sidebar navigation in reference.topics.ts
  • Validate the changes with code review and security scan
  • Update .NET SDK version from 9.0.100 to 10.0.100 per PR feedback

Summary

This PR adds the missing CLI reference documentation for the aspire doctor command. The documentation includes:

  • Description: Explains that the command runs diagnostic checks to verify the development environment is properly configured for Aspire development
  • Categories covered: SDK checks, Container checks, Environment checks
  • Options: --json for automation scenarios, plus standard options (--help, --debug, --wait)
  • Sample output: Shows example output with status indicators (✓ ⚠ ✗)
  • Exit codes: Documents return codes (0 for success, 1 for failures)
  • JSON output format: Shows the structured response format

Security Summary

No security vulnerabilities found - this PR only adds documentation files (MDX and TypeScript sidebar config).

Original prompt

Please add the missing CLI reference for aspire doctor which is apparently good for troubleshooting based on https://github.com/dotnet/aspire/blob/main/src/Aspire.Cli/Commands/DoctorCommand.cs


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@IEvangelist IEvangelist marked this pull request as ready for review January 21, 2026 04:29
Copilot AI review requested due to automatic review settings January 21, 2026 04:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@IEvangelist
Copy link
Member

Tagging @davidfowl to watch this one...

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Add missing CLI reference for aspire doctor Add aspire doctor CLI reference documentation Jan 21, 2026
@IEvangelist
Copy link
Member

Hey @copilot, please see Adam's comments - he's right. Please update accordingly.

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
@IEvangelist IEvangelist merged commit 88adf3d into main Jan 26, 2026
6 checks passed
@IEvangelist IEvangelist deleted the copilot/add-cli-reference-for-doctor branch January 26, 2026 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments