Add six-language core and diagnostics documentation - #1636
Add six-language core and diagnostics documentation#1636David Pine (IEvangelist) wants to merge 6 commits into
Conversation
051e887 to
a843806
Compare
b433d55 to
91c1950
Compare
There was a problem hiding this comment.
🔵 Needs a closer look
The change set is very broad across many docs routes and introduces many new multi-language examples, making it hard to fully validate correctness and rendering safety within this automated review.
Pull request overview
This PR expands Aspire documentation coverage to include consistent six-language (C#, TypeScript, plus experimental Python/Go/Java/Rust) variants across core guidance and diagnostics pages, primarily by standardizing on AppHostTabs and adding explicit per-language limitations where APIs aren’t available.
Changes:
- Introduces/expands multi-language
AppHostTabsblocks across testing, fundamentals, deployment, extensibility, and many diagnostics pages. - Updates language-selection propagation by using the
aspire-langquery parameter in links so AppHost-language pivots sync across pages. - Adds clearer diagnostics context for polyglot AppHosts (what does/doesn’t emit C# diagnostics; experimental setup instructions; file-based AppHost suppression guidance).
File summaries
| File | Description |
|---|---|
| src/frontend/src/content/docs/testing/write-your-first-test.mdx | Updates “first app” link to preserve aspire-lang selection. |
| src/frontend/src/content/docs/testing/manage-app-host.mdx | Adds AppHostTabs examples/limitations for configuration-driven Postgres volume setup. |
| src/frontend/src/content/docs/testing/advanced-scenarios.mdx | Adds multi-language AppHost examples for explicit start + conditional resources. |
| src/frontend/src/content/docs/get-started/troubleshooting.mdx | Adds AppHostTabs for wait-for guidance + service discovery examples. |
| src/frontend/src/content/docs/get-started/aspire-sdk.mdx | Clarifies Aspire.AppHost.Sdk scope (C#), adds AppHostTabs limitations for C#-only directives/types. |
| src/frontend/src/content/docs/get-started/add-aspire-existing-app.mdx | Removes Starlight Tabs usage in favor of AppHostTabs + updates limitation wording. |
| src/frontend/src/content/docs/fundamentals/persist-data-volumes.mdx | Adds additional language variants and AppHostTabs limitations for integration-specific APIs. |
| src/frontend/src/content/docs/fundamentals/http-commands.mdx | Adds AppHostTabs limitations around C#-only DI/HttpClient configuration and full examples. |
| src/frontend/src/content/docs/fundamentals/environment-variables.mdx | Adds AppHostTabs and multi-language examples for reference-driven env var injection and customization. |
| src/frontend/src/content/docs/fundamentals/container-networking.mdx | Adds multi-language examples + limitations for network identifier endpoint resolution. |
| src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx | Adds AppHostTabs framing for TypeScript-generated shapes vs other languages. |
| src/frontend/src/content/docs/extensibility/custom-resources.mdx | Adds AppHostTabs for C#-only extensibility APIs and multi-language relationship examples. |
| src/frontend/src/content/docs/diagnostics/overview.mdx | Expands overview with polyglot applicability, experimental setup, and file-based suppression guidance. |
| src/frontend/src/content/docs/diagnostics/aspirewatch001.mdx | Adds AppHostTabs and polyglot examples for execution context + run configuration. |
| src/frontend/src/content/docs/diagnostics/aspireterminal001.mdx | Adds AppHostTabs and multi-language terminal examples + clarifies option export limitations. |
| src/frontend/src/content/docs/diagnostics/aspireradius057.mdx | Adds InstallPackage + AppHostTabs examples and suppression guidance scoping to C#. |
| src/frontend/src/content/docs/diagnostics/aspireradius006.mdx | Adds InstallPackage + AppHostTabs examples and scopes secret-store APIs as C#-only. |
| src/frontend/src/content/docs/diagnostics/aspireradius004.mdx | Adds InstallPackage + AppHostTabs examples and scopes infra customization callbacks as C#-only. |
| src/frontend/src/content/docs/diagnostics/aspireradius003.mdx | Adds InstallPackage + AppHostTabs examples and scopes provider callbacks as C#-only. |
| src/frontend/src/content/docs/diagnostics/aspirepublishers001.mdx | Clarifies publisher infrastructure as C#-only and links to file-based suppression. |
| src/frontend/src/content/docs/diagnostics/aspireproxyendpoints001.mdx | Adds InstallPackage + AppHostTabs examples across languages for endpoint proxy configuration. |
| src/frontend/src/content/docs/diagnostics/aspireprojects001.mdx | Adds AppHostTabs for “add project” across languages + scopes WithProjectDefaults as C#-only. |
| src/frontend/src/content/docs/diagnostics/aspireprocesscommand001.mdx | Adds AppHostTabs multi-language examples and updates C# sample to container-based call site. |
| src/frontend/src/content/docs/diagnostics/aspirepipelines004.mdx | Clarifies DI-resolved pipeline services are C#-only + file-based suppression link. |
| src/frontend/src/content/docs/diagnostics/aspirepipelines003.mdx | Adds AppHostTabs examples for container build configuration across languages (with Rust limitation). |
| src/frontend/src/content/docs/diagnostics/aspirepipelines002.mdx | Clarifies deployment-state manager APIs are C#-only + suppression link. |
| src/frontend/src/content/docs/diagnostics/aspirepipelines001.mdx | Adds AppHostTabs examples for pipeline steps across languages (with Rust limitation). |
| src/frontend/src/content/docs/diagnostics/aspirehostingpython001.mdx | Adds InstallPackage + AppHostTabs examples and scopes suppression guidance to C#. |
| src/frontend/src/content/docs/diagnostics/aspirefilesystem001.mdx | Adds note scoping file-system services to C#-only AppHost operations. |
| src/frontend/src/content/docs/diagnostics/aspireextension001.mdx | Clarifies callback semantics and scopes generated SDK applicability; adds suppression link. |
| src/frontend/src/content/docs/diagnostics/aspireexport016.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport015.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport013.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport010.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport009.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport008.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport007.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport006.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport005.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport004.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport003.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport002.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspireexport001.mdx | Notes these examples are C# integration-authoring (not generated SDK usage). |
| src/frontend/src/content/docs/diagnostics/aspiredotnettool001.mdx | Adds AppHostTabs multi-language examples and scopes suppression to C# AppHosts. |
| src/frontend/src/content/docs/diagnostics/aspiredotnetproject001.mdx | Adds InstallPackage + AppHostTabs examples and scopes suppression to C# AppHosts. |
| src/frontend/src/content/docs/diagnostics/aspirecsharpapps001.mdx | Adds InstallPackage + AppHostTabs examples and clarifies Rust handle usage guidance. |
| src/frontend/src/content/docs/diagnostics/aspirecosmosdb001.mdx | Adds InstallPackage + AppHostTabs examples; includes Rust callback workaround guidance. |
| src/frontend/src/content/docs/diagnostics/aspirecontainershellexecution001.mdx | Corrects C# sample to set ShellExecution via .Resource and updates suppression snippet. |
| src/frontend/src/content/docs/diagnostics/aspirecontainerruntime001.mdx | Clarifies container runtime service APIs are C#-only DI/service operations. |
| src/frontend/src/content/docs/diagnostics/aspirecompute002.mdx | Adds InstallPackage + AppHostTabs examples and corrects endpoint usage in sample. |
| src/frontend/src/content/docs/diagnostics/aspirecommand001.mdx | Adds AppHostTabs examples across languages (with Rust limitation) + updates suppression snippet. |
| src/frontend/src/content/docs/diagnostics/aspirecertificates001.mdx | Adds InstallPackage + AppHostTabs examples; scopes .NET certificate object overloads to C#. |
| src/frontend/src/content/docs/diagnostics/aspirebrowserlogs001.mdx | Adds InstallPackage + AppHostTabs examples; scopes suppression guidance to C#. |
| src/frontend/src/content/docs/diagnostics/aspireblazor001.mdx | Adds InstallPackage + AppHostTabs examples; clarifies which Blazor APIs are exported vs C#-only. |
| src/frontend/src/content/docs/diagnostics/aspireazure003.mdx | Adds InstallPackage + AppHostTabs examples and scopes suppression to C# AppHosts. |
| src/frontend/src/content/docs/diagnostics/aspireazure001.mdx | Clarifies legacy C# publisher API and scopes generated SDK behavior. |
| src/frontend/src/content/docs/diagnostics/aspireats001.mdx | Updates remediation guidance to include file-based AppHost #:property suppressions. |
| src/frontend/src/content/docs/diagnostics/aspireacanaming002.mdx | Adds InstallPackage + AppHostTabs examples and scopes suppression to C# AppHosts. |
| src/frontend/src/content/docs/diagnostics/aspireacanaming001.mdx | Adds InstallPackage + AppHostTabs examples and scopes suppression to C# AppHosts. |
| src/frontend/src/content/docs/diagnostics/aspire006.mdx | Adds AppHostTabs multi-language examples showing invalid naming behavior across SDKs. |
| src/frontend/src/content/docs/diagnostics/aspire001.mdx | Clarifies what the warning means and fixes a malformed code-fence title attribute. |
| src/frontend/src/content/docs/deployment/kubernetes/persistent-volumes.mdx | Adds AppHostTabs limitations for missing k8s PV APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx | Adds AppHostTabs limitations for missing k8s/Helm APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/kubernetes/clusters.mdx | Adds AppHostTabs limitations for missing k8s environment APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/kubernetes-ingress.mdx | Adds AppHostTabs limitations for missing k8s ingress/gateway APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/kubernetes-ingress-aks.mdx | Adds AppHostTabs limitations for missing AKS ingress/Helm APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/kubernetes-gateway-aks.mdx | Adds AppHostTabs limitations for missing AKS gateway APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/deploy-with-aspire.mdx | Adds AppHostTabs limitations around Docker Compose environment usage in pipeline examples. |
| src/frontend/src/content/docs/deployment/custom-deployments.mdx | Adds AppHostTabs limitations for custom resource/callback authoring in generated SDKs. |
| src/frontend/src/content/docs/deployment/azure/container-apps.mdx | Adds AppHostTabs limitations for missing Azure env/publishing APIs in generated SDKs; adds polyglot variants for a TypeScript section. |
| src/frontend/src/content/docs/deployment/azure/azure-security-best-practices.mdx | Adds AppHostTabs limitations for missing Azure networking/identity APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/azure/azure-developer-cli.mdx | Adds AppHostTabs limitations for missing Container Apps/azd naming APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/azure/app-service.mdx | Adds AppHostTabs limitations for missing App Service env/publishing APIs in generated SDKs. |
| src/frontend/src/content/docs/deployment/app-lifecycle.mdx | Updates lifecycle text and adds AppHostTabs limitations for Docker Compose + SQL Server example availability. |
| src/frontend/src/content/docs/dashboard/telemetry-after-deployment.mdx | Adds AppHostTabs for multi-language guidance with limitations for App Insights integration APIs. |
| src/frontend/src/content/docs/dashboard/enable-browser-telemetry/blazor-webassembly.mdx | Adds AppHostTabs limitations for non-exported Blazor hosted APIs and cleans up whitespace. |
| src/frontend/src/content/docs/architecture/resource-model.mdx | Adds AppHostTabs limitations and updates “first app” link to preserve aspire-lang. |
| src/frontend/src/content/docs/app-host/with-terminal.mdx | Adds additional language variants + clarifies limitations and removes unsupported TS replicas example. |
| src/frontend/src/content/docs/app-host/typescript-apphost.mdx | Updates “See also” link to preserve aspire-lang. |
| src/frontend/src/content/docs/app-host/hot-reload-and-watch.mdx | Broadens watch-mode language guidance and adds per-language pivots. |
| src/frontend/src/content/docs/app-host/configuration.mdx | Adds additional AppHostLanguagePivot sections for Python/Go/Java/Rust profile examples. |
Review details
- Files reviewed: 103/122 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
91c1950 to
cc00884
Compare
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
cc00884 to
92ee7a3
Compare
Cover all 51 shared AppHost example groups across 38 diagnostics pages, preserve explicit C#-only and Rust limitations, and add registry-driven content and browser coverage. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
92ee7a3 to
e6bd2e2
Compare
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Stack 3/5. Depends on #1635.
Summary
Python, Go, Java, and Rust remain disabled until stack 5.
Validation
git diff --check origin/ievangelist-add-integration-docs...HEADpnpm --dir src/frontend exec vitest run tests/unit/apphost-language-coverage.vitest.test.ts tests/unit/diagnostics-language.vitest.test.ts tests/unit/apphost-languages.vitest.test.ts --reporter=dot(3 files, 84 tests passed)