From 9ef04ddaaa3f594ca6d7c96e9ad7a4f7431b1542 Mon Sep 17 00:00:00 2001 From: "aspire-repo-bot[bot]" <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:32:12 +0000 Subject: [PATCH 1/3] Document godoc in generated Go SDK --- src/frontend/src/content/docs/app-host/go-apphost.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/frontend/src/content/docs/app-host/go-apphost.mdx b/src/frontend/src/content/docs/app-host/go-apphost.mdx index ebaea02456..a66a3be51b 100644 --- a/src/frontend/src/content/docs/app-host/go-apphost.mdx +++ b/src/frontend/src/content/docs/app-host/go-apphost.mdx @@ -199,6 +199,14 @@ The SDK regenerates when: The starter's `.gitignore` already lists `.aspire/`. The directory holds generated files that the CLI recreates from `aspire.config.json`, so keep it out of source control. ::: +### Documentation in the SDK + +The generated `aspire.go` carries godoc comments for the SDK's functions, methods, interfaces, structs, enums, and their values. The comments come from the same documentation metadata that the TypeScript SDK turns into JSDoc, so `go doc` and editor hover in gopls show the summary, remarks, a `Parameters:` list, and a `Returns:` paragraph. + +- Obsolete APIs end with a `Deprecated:` paragraph, which gopls and staticcheck recognize. +- Experimental APIs get a `# Experimental` heading and the line `Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.` +- Cross-references to other generated types appear as `[Name]` doc links. Other references stay plain text. + ### Restore the SDK Run `aspire restore` to regenerate the SDK without starting the AppHost: From 200feac7f06568277410beed27489d4ffaa382ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Ros?= <1165805+sebastienros@users.noreply.github.com> Date: Fri, 13 Nov 2026 14:45:29 -0800 Subject: [PATCH 2/3] Trim godoc section to what users see --- src/frontend/src/content/docs/app-host/go-apphost.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/frontend/src/content/docs/app-host/go-apphost.mdx b/src/frontend/src/content/docs/app-host/go-apphost.mdx index ad1c2a3eb6..73b4c10ac3 100644 --- a/src/frontend/src/content/docs/app-host/go-apphost.mdx +++ b/src/frontend/src/content/docs/app-host/go-apphost.mdx @@ -199,11 +199,7 @@ The starter's `.gitignore` already lists `.aspire/`. The directory holds generat ### Documentation in the SDK -The generated `aspire.go` carries godoc comments for the SDK's functions, methods, interfaces, structs, enums, and their values. The comments come from the same documentation metadata that the TypeScript SDK turns into JSDoc, so `go doc` and editor hover in gopls show the summary, remarks, a `Parameters:` list, and a `Returns:` paragraph. - -- Obsolete APIs end with a `Deprecated:` paragraph, which gopls and staticcheck recognize. -- Experimental APIs get a `# Experimental` heading and the line `Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.` -- Cross-references to other generated types appear as `[Name]` doc links. Other references stay plain text. +The generated `aspire.go` includes godoc comments, so `go doc` and editor hover (gopls) show each API's summary, parameters, and return value. Obsolete APIs carry a `Deprecated:` notice that gopls and staticcheck flag, and experimental APIs are marked with an **Experimental** heading. ### Restore the SDK From 1db920e6dae1c8871ac1770de8810a6bd105e5bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Ros?= <1165805+sebastienros@users.noreply.github.com> Date: Fri, 13 Nov 2026 15:27:14 -0800 Subject: [PATCH 3/3] Fix aspire destroy unknown-option sample failing CLI options test The unknown-arguments example ran 'aspire destroy --force' in a bash block, which the pipeline command options unit test flags as an undocumented option. Describe the invalid option in prose and keep the error output. --- src/frontend/.starlight-icons/safelist.json | 3 +++ .../content/docs/reference/cli/commands/aspire-destroy.mdx | 6 +----- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/frontend/.starlight-icons/safelist.json b/src/frontend/.starlight-icons/safelist.json index 8b9037434c..20f8fa07f8 100644 --- a/src/frontend/.starlight-icons/safelist.json +++ b/src/frontend/.starlight-icons/safelist.json @@ -40,8 +40,11 @@ "i-material-icon-theme:folder-src-open", "i-material-icon-theme:folder-template", "i-material-icon-theme:folder-template-open", + "i-material-icon-theme:folder-vscode", + "i-material-icon-theme:folder-vscode-open", "i-material-icon-theme:git", "i-material-icon-theme:go", + "i-material-icon-theme:go-mod", "i-material-icon-theme:gradle", "i-material-icon-theme:html", "i-material-icon-theme:http", diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-destroy.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-destroy.mdx index 9b11c6b323..0b50b6a6e7 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-destroy.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-destroy.mdx @@ -53,11 +53,7 @@ The destroy command requires --yes when the --non-interactive option is specifie ### Unknown arguments -`aspire destroy` rejects unrecognized options and positional arguments before it discovers or starts the AppHost, so a mistyped option can't silently run the destroy pipeline. The command exits with code `1`: - -```bash title="Aspire CLI" -aspire destroy --force -``` +`aspire destroy` rejects unrecognized options and positional arguments before it discovers or starts the AppHost, so a mistyped option can't silently run the destroy pipeline. For example, passing `--force`, which isn't an `aspire destroy` option, exits with code `1` and reports: ```text title="Output" Unrecognized command or argument '--force'.