Promote the Aspire VS Code extension in docs#1211
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
adamint
requested review from
IEvangelist,
davidfowl and
maddymontaquila
as code owners
There was a problem hiding this comment.
Pull request overview
Improves discoverability of the Aspire VS Code extension across the getting-started documentation by adding entry points and cross-links, and enhances the extension guide with a short demo video and updated “happy path” instructions.
Changes:
- Adds a “Use VS Code” LinkCard to the docs landing page.
- Cross-links the VS Code extension from CLI install, first-app, and AppHost getting-started pages.
- Updates the VS Code extension page with a looping demo video and a new “Dashboard from VS Code” section.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/index.mdx | Adds a “Use VS Code” entry point on the docs homepage CardGrid. |
| src/frontend/src/content/docs/get-started/install-cli.mdx | Adds a tip callout linking to the VS Code extension from the CLI install guide. |
| src/frontend/src/content/docs/get-started/first-app.mdx | Adds VS Code tip callouts for both C# and TypeScript quickstart pivots. |
| src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx | Adds a looping demo video + caption and a “Dashboard from VS Code” section. |
| src/frontend/src/content/docs/get-started/app-host.mdx | Adds a tip Aside linking to using the AppHost from VS Code. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 5/6 changed files
- Comments generated: 2
| ]} | ||
| /> | ||
|
|
||
| <p><em>Open a repo, let the extension find the AppHost, press <strong>F5</strong>, then use the Aspire view and dashboard while the app runs.</em></p> |
There was a problem hiding this comment.
Fixed in 9956303: removed the video embed and the remaining F5 reference now uses Kbd.
| :::tip[Using VS Code?] | ||
| Install the [Aspire VS Code extension](/get-started/aspire-vscode-extension/) after the CLI. It can run the CLI install command from the Command Palette, discover AppHosts in your workspace, and start debugging with **F5**. | ||
| ::: |
There was a problem hiding this comment.
Fixed in 9956303: imported Kbd and use it for the F5 shortcut.
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Description
Make the Aspire VS Code extension easier to find from the getting-started docs.
This adds a VS Code entry point to the docs home page, cross-links the extension from the CLI install, first app, and AppHost pages, and tightens the extension guide around the happy path: open or create an Aspire app, let the extension find the AppHost, press F5, then use the Aspire view and dashboard while the app runs.
Validation
pnpm run build:skip-searchpnpm run lintReview