Skip to content

Restructure VS Code extension page (polyglot + 13.2 features)#802

Merged
adamint merged 38 commits into
mainfrom
docs/vscode-extension-polyglot
May 6, 2026
Merged

Restructure VS Code extension page (polyglot + 13.2 features)#802
adamint merged 38 commits into
mainfrom
docs/vscode-extension-polyglot

Conversation

@davidfowl
Copy link
Copy Markdown
Contributor

Rewrites get-started/aspire-vscode-extension.mdx to 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:

  1. Intro + Prerequisites callout
  2. What you get — hero gallery (CodeLens, sidebar, debug session) with a short bullet pitch
  3. Install the extension
  4. Getting started (with walkthrough tip)
  5. Live editor integration (promoted) — CodeLens + gutter decorations
  6. The Aspire sidebar (promoted)aspire describe --follow, health icons, tooltips
  7. Run, debug, and deploy — flat section, no H3 staircase
  8. Language coverage
  9. MCP server integration
  10. Reference (Settings table + Commands in a <details>)
  11. Feedback and issues

Content changes

Polyglot fixes

  • launch.json examples use ${workspaceFolder} (auto-discovery) instead of MyAppHost.csproj.
  • debuggers keys cover all six supported types: apphost, project, node, python, browser, azure-functions.
  • New TypeScript AppHost paragraph and Azure Functions paragraph in language coverage.

13.2 features now documented

  • CodeLens above resource definitions (state + Start/Stop/Restart/View Logs)
  • Gutter decorations color-coded by resource state
  • aspire.config.json AppHost discovery (works for both *.csproj and apphost.ts)
  • CLI auto-detection at the default install location, plus code-insiders fallback
  • Walkthrough with clickable terminal links
  • Real-time sidebar updates via aspire describe --follow
  • Health-aware icons + markdown tooltips
  • Right-click context menus on resources and endpoint URLs
  • Workspace vs Global mode toggle in the sidebar
  • AppHost exit messages in the debug console
  • Debuggable publish, deploy, and do flows
  • Azure Functions debugging
  • enableAspireDashboardAutoLaunch setting

De-table-ification

  • 'Features at a glance' table removed entirely
  • Commands table → 3 narrative paragraphs (now in collapsed <details>)
  • Languages table → prose
  • 'Customizing debugger settings' table → prose
  • Settings table kept (the only one that earns its place)

Screenshots — TODO

Three new screenshots needed, dark + light = 6 PNG files in src/frontend/src/assets/get-started/:

Filename Used in Capture
code-extension-codelens{,-light}.png Hero + Live editor section AppHost source with CodeLens above resources (state + actions) and colored gutter dots
code-extension-sidebar{,-light}.png Hero + Sidebar section Aspire panel with resource tree, health icons, hover tooltip, Workspace/Global toggle
code-extension-debug{,-light}.png Hero only Run & Debug view with multiple sessions attached (AppHost + .NET + Node + browser)

Slots 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

davidfowl and others added 7 commits May 2, 2026 22:23
- 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>
Comment thread src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx Outdated
davidfowl and others added 9 commits May 4, 2026 07:03
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 adamint marked this pull request as ready for review May 6, 2026 03:44
@adamint adamint requested a review from mitchdenny as a code owner May 6, 2026 03:44
Copilot AI review requested due to automatic review settings May 6, 2026 03:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/configuration.mdx
@adamint adamint force-pushed the docs/vscode-extension-polyglot branch from da3c5dc to 06590b3 Compare May 6, 2026 03:58
@adamint adamint force-pushed the docs/vscode-extension-polyglot branch from 1eaf43c to 3a344ef Compare May 6, 2026 16:19
@adamint adamint force-pushed the docs/vscode-extension-polyglot branch from 0ae3a94 to 038b219 Compare May 6, 2026 16:27
@adamint adamint enabled auto-merge (squash) May 6, 2026 17:32
@adamint adamint merged commit 060a73b into main May 6, 2026
5 checks passed
@adamint adamint deleted the docs/vscode-extension-polyglot branch May 6, 2026 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants