Skip to content

Add Getting Started walkthrough to VS Code extension#14872

Merged
adamint merged 3 commits intomicrosoft:release/13.2from
adamint:dev/adamint/walkthrough
Mar 3, 2026
Merged

Add Getting Started walkthrough to VS Code extension#14872
adamint merged 3 commits intomicrosoft:release/13.2from
adamint:dev/adamint/walkthrough

Conversation

@adamint
Copy link
Member

@adamint adamint commented Mar 3, 2026

Description

Adds a Getting Started walkthrough to the Aspire VS Code extension. The walkthrough guides new users through installing the CLI, creating a project, running their app, exploring the dashboard, and next steps — all from within VS Code.

What's included

6 walkthrough steps:

  1. Welcome to Aspire — overview of key benefits, how it works, polyglot support
  2. Install the Aspire CLI — platform-specific install commands (stable + daily) with clickable terminal links
  3. Create a new project — links to the Aspire: New Aspire Project command, explains the apphost and template structure
  4. Run your app — run/debug via extension commands, dashboard screenshot, link to dashboard overview
  5. Explore the dashboard — resources, endpoints, logs, traces, metrics, health monitoring
  6. Next steps — integrations, publish/deploy, learning resources

3 new commands for the install step:

  • aspire-vscode.installCliStable — runs the stable CLI install script in a terminal
  • aspire-vscode.installCliDaily — runs the daily/preview CLI install script in a terminal
  • aspire-vscode.verifyCliInstalled — runs aspire --version to verify installation

All strings are localized via package.nls.json. Markdown panels include clickable command: links to run extension commands directly.

Screenshots

Welcome to Aspire

image

Install the Aspire CLI

image

Create a new project

image

Run your app

image

Explore the dashboard

image

Next steps

image

Fixes #11910

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
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

Copilot AI review requested due to automatic review settings March 3, 2026 04:08
@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 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 -- 14872

Or

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

@adamint adamint force-pushed the dev/adamint/walkthrough branch 3 times, most recently from 396908d to 89e27f9 Compare March 3, 2026 04:10
@adamint adamint requested a review from maddymontaquila March 3, 2026 04:12
@adamint adamint self-assigned this Mar 3, 2026
@adamint adamint force-pushed the dev/adamint/walkthrough branch from 89e27f9 to 9d8c61b Compare March 3, 2026 04:15
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

Adds a Getting Started walkthrough to the Aspire VS Code extension to onboard new users (CLI install → project creation → run/debug → dashboard → next steps) directly inside VS Code.

Changes:

  • Introduces 6 walkthrough markdown panels under extension/walkthrough/ and wires them into contributes.walkthroughs.
  • Adds 3 new walkthrough-focused commands to install/verify the Aspire CLI and registers them during extension activation.
  • Localizes all new command titles and walkthrough step titles/descriptions via package.nls.json.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
extension/walkthrough/welcome.md Walkthrough step content: Aspire overview, benefits, and how it works.
extension/walkthrough/installCli.md Walkthrough step content: stable/daily install instructions + command links.
extension/walkthrough/createProject.md Walkthrough step content: scaffolding a project and apphost explanation.
extension/walkthrough/runApp.md Walkthrough step content: run/debug flow and dashboard link/screenshot.
extension/walkthrough/dashboard.md Walkthrough step content: dashboard concepts and health statuses.
extension/walkthrough/nextSteps.md Walkthrough step content: integrations, deployment, and learning links.
extension/src/extension.ts Registers the new walkthrough commands with VS Code.
extension/src/commands/walkthroughCommands.ts Implements terminal-based CLI install (stable/daily) and verify commands.
extension/package.nls.json Adds localized strings for the new commands and walkthrough steps.
extension/package.json Contributes the new commands and the new walkthrough definition.

Copy link
Contributor

@maddymontaquila maddymontaquila left a comment

Choose a reason for hiding this comment

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

100/10

**The apphost** is the heart of your app — it defines everything in code:

```csharp
var builder = DistributedApplication.CreateBuilder(args);
Copy link
Contributor

Choose a reason for hiding this comment

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

This is good for now but when we ship 13.2 maybe replace it w whatever typescript template we ship?

Co-authored-by: Maddy Montaquila (Leger) <maddyleger1@gmail.com>
@adamint adamint enabled auto-merge (squash) March 3, 2026 16:34
@adamint adamint merged commit 976951f into microsoft:release/13.2 Mar 3, 2026
383 of 384 checks passed
@dotnet-policy-service dotnet-policy-service bot added this to the 13.2 milestone Mar 3, 2026
Copilot AI pushed a commit that referenced this pull request Mar 10, 2026
* Add Getting Started walkthrough to VS Code extension

* Update extension/walkthrough/dashboard.md

Co-authored-by: Maddy Montaquila (Leger) <maddyleger1@gmail.com>

---------

Co-authored-by: Maddy Montaquila (Leger) <maddyleger1@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants