Skip to content

[docs] Document aspire sdk export for Go - #1980

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-21195-40984410436-1-629118edece160d4
Closed

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-21195-40984410436-1-629118edece160d4

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#21195

Author: @sebastienros is the reviewer; source PR author mention: the PR author of #21195.

Targeting release/17.0 based on the source PR milestone 17.0 (target_resolution: exact_match, candidate_source: pr_milestone).

Why: aspire sdk export --language go previously failed because no Go exporter existed. PR #21195 adds one, so the Go export needs documenting.

Changes: Updated src/frontend/src/content/docs/whats-new/aspire-17.mdx (existing page) with a new "Export Go API reference data" section and example command.

Generated by PR Documentation Check for #21195 · copilot · auto · 29.5 AIC · ⌖ 1.13 AIC · ⊞ 7.1K · ◷

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@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 #1980. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1980 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#21195 (merged 2026-10-30)
PR status: draft, mergeable, bot-authored, opened 2026-10-30 — not stale.

Phase A — claims

  • ✅ source PR merged ('Add aspire sdk export -l go'); doc states the exporter and --language go support.
  • ⚠️ nuance: release-notes style entry; confirm it sits in the correct what's-new version page.

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.

🟡 Changes recommended

The new subsection heading skips from level 2 to level 4, disrupting screen-reader navigation, and should use level 3.

1 open issue
What changed in this PR

Updates the Aspire 17 release notes to document Go API reference export support introduced in microsoft/aspire#21195.

Changes:

  • Adds an aspire sdk export --language go command example.
  • Describes SDK signature alignment, JSON output, and package-specific exports.
File Description
src/​frontend/​src/​content/​docs/​whats-new/​aspire-17.mdx Adds a Go API reference export section under new features.

Review effort: Balanced


## ✨ New features

#### Export Go API reference data
@sebastienros

Copy link
Copy Markdown
Contributor

Closing: aspire sdk is a hidden command (Hidden = true in SdkCommand.cs) with no aspire.dev reference page. aspire sdk export exists to feed aspire.dev's own Go API reference pipeline, so it doesn't belong in the user-facing 17.0 release notes. Details like Build()/Err()/ToMap() on exported signatures are generator internals.

@sebastienros
Sébastien Ros (sebastienros) deleted the docs/pr-21195-40984410436-1-629118edece160d4 branch November 13, 2026 22:40
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