Restructure VS Code extension page (polyglot + 13.2 features)#802
Merged
Conversation
- Lead with a 'What you get' gallery (CodeLens, sidebar, debug) instead
of opening with prerequisites and install boilerplate.
- Promote 'Live editor integration' and 'Aspire sidebar' above
run/debug — they're the differentiating 13.2 features.
- Demote Prerequisites to a callout below the intro.
- Document 13.2 additions: CodeLens + gutter decorations, real-time
sidebar via 'aspire describe --follow', health-aware icons and
markdown tooltips, walkthrough with clickable terminal links,
aspire.config.json AppHost discovery (TS + C#), CLI auto-detect at
default install path, code-insiders fallback, debug console exit
messages, debuggable publish/deploy/do flows, Azure Functions.
- De-C#-ify: launch.json examples use ${workspaceFolder}; debuggers
table covers all keys (apphost, project, node, python, browser,
azure-functions); add a TypeScript AppHost paragraph.
- Convert remaining tables to prose (Features, Commands, Languages);
collapse run/debug/deploy H3s into one flat section; group Settings
+ Commands under a Reference H2 with Commands in a <details>.
- Add screenshot placeholders for code-extension-codelens, sidebar,
and debug (filenames noted in TODO comments).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Per doc-writer skill, prefer fenced ::: syntax for callouts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
VS Code is evergreen and the marketplace already enforces the extension's engines.vscode floor at install time. Stating a specific version just adds friction and goes stale. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Users don't need to know the underlying CLI command — they just need to know the sidebar updates in real time. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The page was mixing 'Aspire panel' with 'Aspire sidebar'. In VS Code, 'Panel' specifically means the bottom area (Terminal, Output, etc.), not the area opened from the Activity Bar. The official term for what an extension contributes to that area is a 'view' in the Side Bar. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The single paragraph listing every language, debugger, and required extension was hard to scan. Tabular form makes the matrix obvious. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The previous intro was a feature list. The actual reason to use the extension over the CLI is coordinated debugging across multiple languages from a single keystroke. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
IEvangelist
reviewed
May 4, 2026
Addresses PR #802 review feedback from @IEvangelist: use the project's existing Expand component for consistent styling instead of a raw <details>/<summary> block. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Integrates content from three release/13.3-only commits that have not yet been merged back to main: - #816 (e3d537a): gutter icon shape table and code lens health-check details - #810 (8f4800d): integratedBrowser default + Dashboard browser options table - #813 (2a664d1): Restore command + aspire.enableAutoRestore setting Cherry-picking failed because of the polyglot restructure, so the changes were applied manually to fit the new section layout.
…tions - Removed the Settings table, the Dashboard browser options subsection, and the MCP server integration section. - Dropped the Reference wrapper; promoted Commands to a top-level section. - Trimmed verbose prose throughout (intro, Getting started, Aspire view, Run/debug/deploy, Commands). - Fixed broken anchor link to the removed Settings section in the Restore description.
Replaces the manual json.schemas snippet in the CLI configuration reference with a one-line note pointing to the extension page.
…content
- Add code-extension-{codelens,sidebar,debug}{,-light}.png assets and wire them into the Live editor integration, Aspire view, and Run/debug/deploy sections (light variants TBD).
- Add a Scaffold and add integrations section covering Add an integration, Initialize, Update integrations, and Open Aspire terminal.
- Mention the editor title bar Run apphost / Debug apphost buttons in Live editor integration.
- Tighten the configuration.mdx VS Code schema-registration note.
adamint
approved these changes
May 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Aspire VS Code extension documentation to be more polyglot-focused and narrative-driven, and adjusts related CLI configuration guidance to reference the extension’s auto-registered JSON schema.
Changes:
- Rewrites the VS Code extension guide (
get-started/aspire-vscode-extension.mdx) with a new structure, new screenshots, and updated launch/debug guidance. - Simplifies VS Code JSON schema association guidance in the CLI configuration doc by pointing users to the VS Code extension.
Reviewed changes
Copilot reviewed 2 out of 8 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx | Major restructure/rewrite of the VS Code extension page, including new sections and updated launch.json examples. |
| src/frontend/src/content/docs/reference/cli/configuration.mdx | Replaces manual VS Code schema association instructions with a note about the VS Code extension auto-registering the schema. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…mmand from launch example
3e8c3a3 to
f20ead5
Compare
Closed
4 tasks
da3c5dc to
06590b3
Compare
…rs without the extension
1eaf43c to
3a344ef
Compare
0ae3a94 to
038b219
Compare
IEvangelist
approved these changes
May 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites
get-started/aspire-vscode-extension.mdxto be polyglot-first, narrative instead of table-heavy, and to cover the major 13.2 extension features that weren't documented.Layout changes
Sections in the old order: Prerequisites → Install → Getting started → Running and debugging → Sidebar → Commands (table) → Languages (table) → Settings (table) → MCP → Feedback.
New order:
aspire describe --follow, health icons, tooltips<details>)Content changes
Polyglot fixes
launch.jsonexamples use${workspaceFolder}(auto-discovery) instead ofMyAppHost.csproj.debuggerskeys cover all six supported types:apphost,project,node,python,browser,azure-functions.13.2 features now documented
aspire.config.jsonAppHost discovery (works for both*.csprojandapphost.ts)code-insidersfallbackaspire describe --followpublish,deploy, anddoflowsenableAspireDashboardAutoLaunchsettingDe-table-ification
<details>)Screenshots — TODO
Three new screenshots needed, dark + light = 6 PNG files in
src/frontend/src/assets/get-started/:code-extension-codelens{,-light}.pngcode-extension-sidebar{,-light}.pngcode-extension-debug{,-light}.pngSlots are marked with
{/* TODO */}MDX comments naming the exact file. Page builds and passes lint + unit tests as-is.Validation
pnpm --dir ./src/frontend run lint✅pnpm --dir ./src/frontend run test:unit:docs✅