Skip to content

Consolidate docs-from-code updates for Aspire 17.0 - #2189

Merged
David Pine (IEvangelist) merged 11 commits into
release/17.0from
ievangelist-consolidate-docs-from-code-17
Nov 17, 2026
Merged

David Pine (IEvangelist) merged 11 commits into
release/17.0from
ievangelist-consolidate-docs-from-code-17

Conversation

@IEvangelist

Copy link
Copy Markdown
Member

Summary

Consolidates the open docs-from-code PRs that cover features from David Pine (@IEvangelist)'s product work or that request their review, all targeting release/17.0, into this single PR. Each PR was checked against its merged microsoft/aspire source PR and against product release/17.0, to confirm the change shipped in 17.0 and is user-facing rather than an implementation detail. Accepted text was corrected where the bot's wording was inaccurate.

PR(s) Verdict Notes
#2103, #2098, #1967, #2073, #2070 Accepted with fixes Go AppHost conventions, aspire init, and VS Code extension. Unrelated e2e test edits from #2073 were dropped.
#1972 Partially accepted Only the verified behavior was kept.
#2069, #2064, #1829 Accepted with fixes Dashboard explore page and aspire describe --format Mermaid
#2044 Partially accepted The Cards/Home/Graph layout selector text is outdated, so it was dropped.
#1959, #1904, #1835, #1801 Accepted with fixes WithTerminal options, the dashboard terminal UX, and TypeScript configure
#1902 Accepted with fixes dotnet run --operation publish guidance
#2081 Accepted with fixes WSLc limited publish support. The minimum version is corrected to 3.0.4.0.
#2014, #1862, #1809, #1936, #2140, #1997, #2051, #2068, #2022, #1963 Accepted with fixes DCP timeouts, the container tunnel base image, browser origins, the PVC WithConfiguration API, the interaction service caution, secrets, aspire update, and agent init telemetry
#2092 Rejected Documents implementation details.
#2078 Rejected Already documented correctly; the proposed text was wrong.
#2110, #2104, #2085, #2094 Rejected The product change isn't in release/17.0; it's 17.1-only. Redo these against the next release branch.
#2133 Rejected for now Its backport, microsoft/aspire#22219, is still open, so redo this once it merges.

Additional consistency fixes:

  • WSLc: the minimum version is now 3.0.4.0, the source's MinimumWslcVersion, across prerequisites, aspire doctor, configuration, and what's new. The pages now describe limited publish support and state that Docker Compose isn't supported.
  • WithTerminal: WithTerminal and TerminalOptions are no longer [Experimental] in 17.0. I removed the stale ASPIRETERMINAL001 pragmas and cautions and rewrote the diagnostic page to cover the terminal APIs that are still experimental.

Closes #2140
Closes #2133
Closes #2110
Closes #2104
Closes #2103
Closes #2098
Closes #2094
Closes #2092
Closes #2085
Closes #2081
Closes #2078
Closes #2073
Closes #2070
Closes #2069
Closes #2068
Closes #2064
Closes #2051
Closes #2044
Closes #2022
Closes #2014
Closes #1997
Closes #1972
Closes #1967
Closes #1963
Closes #1959
Closes #1936
Closes #1904
Closes #1902
Closes #1862
Closes #1835
Closes #1829
Closes #1809
Closes #1801

Third-party links and affiliations

None. The only added external link is to mermaid.js.org, which the page already links elsewhere.

Validation

  • I compared each claim with the merged microsoft/aspire source and checked that it's included in product release/17.0, using gh api compare and searches for backport PRs.
  • I checked the TypeScript sample against the generated aspire.d.ts. EndpointReferenceExpression is an IValueProvider.
  • I reviewed the full diff by hand for MDX and table formatting, imports, and anchors. The new seoTitle is 58 characters.
  • I didn't run any local unit, e2e, or build commands because frontend dependencies aren't installed locally. CI covers the build, unit, and e2e checks, including the updated custom-components.spec.ts assertion.

Validates and consolidates the open docs-from-code PRs that relate to
IEvangelist's product work or request their review, checking each against
its merged microsoft/aspire source and the product release/17.0 branch.

Also aligns WSLc guidance with the 3.0.4.0 minimum and limited publish
support, and documents that WithTerminal/TerminalOptions are no longer
experimental (ASPIRETERMINAL001 now covers the remaining terminal APIs).

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

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.

🟡 Changes recommended

The documentation still points readers to the wrong file for failed secret imports and overstates fixed terminal sizing by omitting the dock’s automatic fitting.

2 open issues
What changed in this PR

Consolidates Aspire 17.0 documentation updates across AppHost configuration, CLI commands, deployment, and dashboard features in the aspire.dev documentation site.

Changes:

  • Documents Go AppHost improvements, browser-facing origins, Kubernetes volume customization, and CLI behavior.
  • Updates terminal guidance to distinguish stable resource APIs from experimental terminal APIs.
  • Aligns WSLc requirements and publishing limitations across documentation and the related end-to-end assertion.
File Description
src/​frontend/​tests/​e2e/​custom-components.spec.ts Updates WSLc version and limitation assertions.
src/​frontend/​src/​content/​docs/​whats-new/​aspire-17.mdx Corrects the WSLc release summary.
src/​frontend/​src/​content/​docs/​reference/​cli/​microsoft-collected-cli-telemetry.mdx Clarifies user-level telemetry hooks and filtering.
src/​frontend/​src/​content/​docs/​reference/​cli/​includes/​config-settings-table.md Adds tunnel image and AppHost Server v2 settings.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-update.mdx Explains NuGet feed and mapping preservation.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-secret.mdx Adds malformed-secrets recovery guidance.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-secret-path.mdx Clarifies path lookup without loading secrets.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-init.mdx Describes Go initialization in existing modules.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-doctor.mdx Updates WSLc version examples.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-describe.mdx Documents Mermaid graph export.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-agent-init.mdx Explains telemetry hook installation scope.
src/​frontend/​src/​content/​docs/​get-started/​troubleshooting.mdx Adds publish-mode launch troubleshooting.
src/​frontend/​src/​content/​docs/​get-started/​prerequisites.mdx Details WSLc requirements and limited publishing.
src/​frontend/​src/​content/​docs/​get-started/​aspire-vscode-extension.mdx Updates Go CodeLens and debugger setup guidance.
src/​frontend/​src/​content/​docs/​get-started/​aspire-sdk.mdx Directs publishing workflows to aspire publish.
src/​frontend/​src/​content/​docs/​fundamentals/​networking-overview.mdx Introduces browser-facing endpoint origins.
src/​frontend/​src/​content/​docs/​fundamentals/​container-networking.mdx Explains custom tunnel base images and precedence.
src/​frontend/​src/​content/​docs/​extensibility/​interaction-service.mdx Warns against prompts during before-start execution.
src/​frontend/​src/​content/​docs/​diagnostics/​overview.mdx Updates the terminal diagnostic description.
src/​frontend/​src/​content/​docs/​diagnostics/​aspireterminal001.mdx Distinguishes experimental APIs from stable WithTerminal.
src/​frontend/​src/​content/​docs/​deployment/​kubernetes/​persistent-volumes.mdx Adds claim customization callbacks and examples.
src/​frontend/​src/​content/​docs/​dashboard/​terminals.mdx Documents navigation, palettes, recovery, and API stability.
src/​frontend/​src/​content/​docs/​dashboard/​explore.mdx Clarifies panels, resource selection, endpoints, and export.
src/​frontend/​src/​content/​docs/​app-host/​with-terminal.mdx Updates sizing defaults and TypeScript configuration.
src/​frontend/​src/​content/​docs/​app-host/​go-apphost-conventions.mdx Explains derived handles and error aggregation.
src/​frontend/​src/​content/​docs/​app-host/​console-apps.mdx Removes outdated WithTerminal experimental warnings.
src/​frontend/​src/​content/​docs/​app-host/​configuration.mdx Adds tunnel settings, DCP timeouts, and path-resolution guidance.

Review effort: Balanced

Resolve overlapping terminal documentation while preserving the latest replica-selection guidance.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Clarify that the terminal dock still auto-fits configured resource terminals, and direct readers to repair the malformed file reported by Aspire.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

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

VS Code: Open PR #2189 artifacts

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

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>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.

2 participants