[docs] Add docs for Aspire.Hosting.Dotnet integration - #1437
Conversation
Adds new integration docs for the Aspire.Hosting.Dotnet hosting integration (AddDotnetProject / addDotnetProject), which lets AppHosts add C# projects and file-based C# apps by path, as the C# peer of the Go/Python/JavaScript hosting integrations. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
David Pine (IEvangelist)
left a comment
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
Validated against microsoft/aspire#18442 and the current Aspire.Hosting.Dotnet API/README. The package, C# and TypeScript APIs, launch behavior, experimental diagnostic, navigation, and integration lookup are documented accurately.
There was a problem hiding this comment.
Pull request overview
Adds new Aspire docs content for the Aspire.Hosting.Dotnet hosting integration, including navigation + integration lookup wiring, so users can discover and use AddDotnetProject / addDotnetProject to add C# projects or file-based .cs apps by path.
Changes:
- Adds new get-started and AppHost API reference pages for the .NET / C# hosting integration.
- Wires the new docs into the integrations sidebar and package-to-docs lookup (
integration-docs.json). - Updates the “C# and .NET apps” languages card to cross-link to the new integration docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/data/integration-docs.json | Adds package→doc-route mapping for Aspire.Hosting.Dotnet. |
| src/frontend/src/content/docs/languages-and-runtimes/index.mdx | Updates the .NET card to link to the new integration. |
| src/frontend/src/content/docs/integrations/frameworks/dotnet/dotnet-host.mdx | New AppHost reference page for AddDotnetProject / addDotnetProject. |
| src/frontend/src/content/docs/integrations/frameworks/dotnet/dotnet-get-started.mdx | New get-started overview page for the integration. |
| src/frontend/config/sidebar/integrations.topics.ts | Adds a “.NET / C#” section and links to the new pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Documents changes from microsoft/aspire#18442
@karolz-msTargeting
release/13.5based on the source PR milestone13.5(exact match found onmicrosoft/aspire.dev).Why
PR microsoft/aspire#18442 adds the new
Aspire.Hosting.Dotnethosting integration package — the C# peer ofAspire.Hosting.Go,Aspire.Hosting.Python, andAspire.Hosting.JavaScript. It introduces:AddDotnetProject/addDotnetProject([Experimental("ASPIREDOTNETPROJECT001")]) to add a C# project or file-based.csapp by path, without referencing it from the AppHost's own solution.DotnetProjectResource.Aspire.Hosting.Dotnetwith its own README.This is new user-facing surface with no prior documentation, so a docs PR is required.
What changed
integrations/frameworks/dotnet/dotnet-get-started.mdx— overview/get-started guide, following the pattern of the Go integration's get-started page.integrations/frameworks/dotnet/dotnet-host.mdx— full AppHost API reference forAddDotnetProject/addDotnetProject, covering installation, adding a project or file-based app by path, and configuration options, using the exact API names, diagnostic ID (ASPIREDOTNETPROJECT001), and behavior described in the PR's README and source.integrations.topics.tsalongside the existing Go/Java/JavaScript framework entries.Aspire.Hosting.Dotnetentry tointegration-docs.jsonso the package resolves to the new get-started page.languages-and-runtimes/index.mdx's "C# and .NET apps" card to link to the new integration.All pages were created as new files; no existing docs described
AddDotnetProject, so this isn't a case of "already documented by name."