Skip to content

[docs] Document godoc comments in generated Go SDK - #1981

Merged
Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21197-40991758835-1-e9d3d770bdca3ee9
Nov 13, 2026
Merged

Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21197-40991758835-1-e9d3d770bdca3ee9

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#21197

Author: @davidfowl-unknown-placeholder

Targeting release/17.0 — the latest release branch on microsoft/aspire.dev — because the source PR has no milestone or release/* base ref to derive a more specific target (candidate_source: fallback_main).

Why

The Go SDK generator now emits godoc from ATS documentation metadata (summary, remarks, parameters, returns, Deprecated:, # Experimental, doc links). The Go AppHost docs did not mention this.

Changes

  • Updated src/frontend/src/content/docs/app-host/go-apphost.mdx: new "Documentation in the SDK" subsection under "Generated SDK".

Triggered signals: polyglot_code_generator_changed, pr_body_has_cli_flag_mention, pr_body_has_deprecation_marker.

Generated by PR Documentation Check for #21197 · copilot · auto · 20 AIC · ⌖ 1.03 AIC · ⊞ 7.1K · ◷

@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Oct 30, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

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

VS Code: Open PR #1981 artifacts

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

Copy link
Copy Markdown
Member

docs-pr-reviewer report — [partial — phase A: key claims evaluated; phase B: not run (docs site was not served in this automated run)]

Recommendation: approve

Source used: microsoft/aspire#21197 (merged 2026-10-30)
PR status: draft, mergeable, bot-authored, opened 2026-10-30 — not stale.

Phase A — claims

  • ✅ source PR merged ('Emit godoc from ATS documentation metadata'); Deprecated:, # Experimental heading and [Name] doc-link behavior are as described in the PR.
  • ⚠️ nuance: exact Notice text not verified.

Phase B — doc-tester

Not run; rendering of the changed pages is not browser-checked.

🤖 Posted by aspire.dev - squad (AI Agent)

@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review November 13, 2026 14:56
Copilot AI balanced review requested due to automatic review settings November 13, 2026 14:56

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.

🔵 Needs a closer look

Source-file read timeouts and dependency-free review constraints left source accuracy and go doc/editor behavior unverified, requiring human confirmation.

No open issues 🎉

What changed in this PR

Adds documentation about generated Go SDK comments to the Go AppHost guide, covering the generator changes in microsoft/aspire#21197.

Changes:

  • Adds a “Documentation in the SDK” subsection describing godoc content available through go doc and editor hover.
  • Explains deprecation notices, experimental API warnings, and generated-type cross-references.
File Description
src/​frontend/​src/​content/​docs/​app-host/​go-apphost.mdx Documents generated SDK godoc comments and API notices.

Review effort: Balanced

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.
@sebastienros
Sébastien Ros (sebastienros) merged commit 161faac into release/17.0 Nov 13, 2026
16 checks passed
@sebastienros
Sébastien Ros (sebastienros) deleted the docs/pr-21197-40991758835-1-e9d3d770bdca3ee9 branch November 13, 2026 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants