Skip to content

Revamp extension README for clarity and completeness#15156

Merged
adamint merged 12 commits intomicrosoft:release/13.2from
adamint:adamint/revamp-extension-readme
Mar 12, 2026
Merged

Revamp extension README for clarity and completeness#15156
adamint merged 12 commits intomicrosoft:release/13.2from
adamint:adamint/revamp-extension-readme

Conversation

@adamint
Copy link
Member

@adamint adamint commented Mar 12, 2026

Description

Revamps the VS Code extension README and makes a few related naming changes for clarity and consistency.

README overhaul

  • Rewrote the entire README with a clear structure: table of contents, features overview, prerequisites, getting started, running/debugging, sidebar, dashboard, commands, language support, settings, MCP, and feedback
  • Replaced stiff, buzzword-heavy prose with plain, conversational language
  • Consolidated redundant content (merged recommended extensions into the language support table, folded JSON schema docs into settings)
  • Reduced the settings table to the 4 most useful settings, with a note pointing to VS Code settings for the rest
  • Consolidated 4 separate command sub-tables into one flat table grouped by function
  • Removed shell CLI install commands from prerequisites — just links to the install guide and the VS Code command
  • Removed ".NET Aspire" branding (just "Aspire" now)
  • Added the existing dashboard screenshot to the Dashboard section

Command and view renames

  • Renamed "Initialize Aspire""Initialize Aspire in an existing codebase" (package.nls.json)
  • Capitalized the view name from "Running apphosts""Running AppHosts" so the auto-generated VS Code focus command reads correctly (package.nls.json)

Azure Functions correction

  • Updated the language/debugger support table to reflect that Azure Functions debugging supports C#, JS/TS, and Python (not just C#)

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
    • No
  • Does the change require an update in our Aspire docs?
    • Yes
    • No

Copilot AI review requested due to automatic review settings March 12, 2026 02:33
@github-actions
Copy link
Contributor

github-actions bot commented Mar 12, 2026

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 15156

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 15156"

Copy link
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

Revamps extension/README.md to be a more complete, public-facing guide for the Aspire VS Code extension, covering core workflows (run/debug/deploy), UI surfaces (sidebar/dashboard), settings, and MCP integration.

Changes:

  • Reorganized the README with a table of contents and clearer sections (features, prerequisites, getting started, sidebar/dashboard, commands, language support, settings, MCP, feedback).
  • Consolidated and simplified command/settings documentation into cleaner tables and shorter lists.
  • Updated wording/branding for readability and consistency (“Aspire” vs “.NET Aspire”, removed emoji, more conversational prose).

You can also share your feedback on Copilot code review. Take the survey.

@adamint adamint marked this pull request as draft March 12, 2026 02:41
@adamint adamint marked this pull request as ready for review March 12, 2026 02:53
@adamint adamint enabled auto-merge (squash) March 12, 2026 03:22
@adamint adamint merged commit e04d2ce into microsoft:release/13.2 Mar 12, 2026
682 of 708 checks passed
@dotnet-policy-service dotnet-policy-service bot added this to the 13.2 milestone Mar 12, 2026
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.

3 participants