Repository navigation
[docs] Document godoc comments in generated Go SDK - #1981
Sébastien Ros (sebastienros) merged 6 commits into
Conversation
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
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) Phase A — claims
Phase B — doc-testerNot run; rendering of the changed pages is not browser-checked. 🤖 Posted by aspire.dev - squad (AI Agent) |
There was a problem hiding this comment.
🔵 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 docand 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.
Documents changes from microsoft/aspire#21197
Author:
@davidfowl-unknown-placeholderTargeting
release/17.0— the latest release branch onmicrosoft/aspire.dev— because the source PR has no milestone orrelease/*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
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.