Repository navigation
Clarify .NET SDK requirements in CLI and deployment docs - #1817
Conversation
Remove the blanket CLI SDK prerequisite and scope CI SDK setup to the C# AppHost and .NET API examples. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Updates CLI and deployment documentation to avoid implying the .NET SDK is a universal prerequisite for all Aspire CLI workflows, while keeping .NET setup guidance where the examples specifically use C#/.NET projects.
Changes:
- Generalizes
aspire doctorand CLI overview wording to avoid a blanket .NET SDK prerequisite. - Clarifies that GitHub Actions Docker/Docker Compose examples assume a C# AppHost and .NET API, and labels the .NET setup step accordingly.
- Adjusts
aspire doctorcheck descriptions to “report” SDK availability/version rather than implying universal enforcement.
| File | Description |
|---|---|
| src/frontend/src/content/docs/reference/overview.mdx | Updates the aspire doctor card to use neutral environment-check wording. |
| src/frontend/src/content/docs/reference/cli/overview.mdx | Removes the blanket note claiming the CLI requires .NET SDK 10.0.100+. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx | Rewords aspire doctor description and SDK check bullet to be more neutral. |
| src/frontend/src/content/docs/integrations/compute/docker.mdx | Scopes the GH Actions example to the C# AppHost/.NET API and renames the .NET setup step accordingly. |
| src/frontend/src/content/docs/deployment/docker-compose.mdx | Scopes the GH Actions example to the C# AppHost/.NET API and renames the .NET setup step accordingly. |
💡 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>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Summary
Remove the CLI overview's incorrect blanket .NET SDK prerequisite and use neutral environment-check wording in the doctor and reference descriptions.
Scope the Docker and Docker Compose CI examples explicitly to their C# AppHost and .NET API. Keep the SDK setup those projects need, without implying it is required for every Aspire workflow. Prerequisites and historical release notes are unchanged.
Third-party links and affiliations
None.
Validation
pnpm --dir src/frontend run test:unit:docs- passed (2 tests).git diff --check- passed.