Use Kbd component for keyboard shortcuts#1202
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
5ea2256 to
8a5e92b
Compare
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates multiple Aspire docs pages to render keyboard shortcuts using the Starlight Kbd component, with OS-aware variants (Windows/macOS/Linux) where applicable, instead of raw prose or <kbd> markup.
Changes:
- Replaced raw keyboard shortcut markup/prose with
<Kbd ... />across several MDX docs (includingwhats-new,get-started,fundamentals,dashboard, andintegrations). - Normalized shortcut strings (notably moving toward
Ctrl/Commandlabeling) and added Linux variants in several places. - Reordered/added
Kbdimports in updated MDX files.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/whats-new/upgrade-aspire.mdx | Updates VS Code Extensions shortcut to use Kbd with OS variants. |
| src/frontend/src/content/docs/whats-new/aspire-9.mdx | Adds Kbd usage for debugging shortcut and adjusts imports. |
| src/frontend/src/content/docs/whats-new/aspire-13.mdx | Converts Command Palette shortcut to Kbd and adjusts imports. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx | Adds Kbd usage in hot reload/watch guidance (needs mac key fix). |
| src/frontend/src/content/docs/ja/whats-new/aspire-13.mdx | Mirrors Kbd shortcut update in Japanese release notes. |
| src/frontend/src/content/docs/ja/get-started/aspire-vscode-extension.mdx | Normalizes VS Code shortcut key labels in Japanese doc. |
| src/frontend/src/content/docs/ja/fundamentals/telemetry.mdx | Converts <kbd> usage to Kbd for debug workflow reference. |
| src/frontend/src/content/docs/ja/fundamentals/networking-overview.mdx | Adds Kbd and converts terminal stop shortcut (needs mac key fix). |
| src/frontend/src/content/docs/integrations/databases/efcore/migrations.mdx | Updates VS Code terminal shortcut to Kbd format. |
| src/frontend/src/content/docs/integrations/custom-integrations/hosting-integrations.mdx | Normalizes stop shortcut to Kbd (needs mac key fix). |
| src/frontend/src/content/docs/integrations/custom-integrations/client-integrations.mdx | Normalizes stop shortcut to Kbd (needs mac key fix). |
| src/frontend/src/content/docs/get-started/dev-containers.mdx | Updates VS Code terminal shortcut to use Kbd with mac variant. |
| src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx | Normalizes VS Code shortcuts to Kbd with mac Command variant. |
| src/frontend/src/content/docs/fundamentals/telemetry.mdx | Converts <kbd> usage to Kbd for debug workflow reference. |
| src/frontend/src/content/docs/fundamentals/networking-overview.mdx | Adds Kbd and converts terminal stop shortcut (needs mac key fix). |
| src/frontend/src/content/docs/dashboard/standalone-for-python.mdx | Converts stop shortcuts to Kbd (needs mac key fix). |
| src/frontend/src/content/docs/dashboard/standalone-for-nodejs.mdx | Converts stop shortcut to Kbd (needs mac key fix). |
| src/frontend/src/content/docs/dashboard/explore.mdx | Normalizes modifier key name to Ctrl for link-click behavior. |
| src/frontend/src/content/docs/architecture/overview.mdx | Converts <kbd> to Kbd and includes a small grammar issue on an edited line. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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>
alistairmatthews
left a comment
There was a problem hiding this comment.
Checks out. Good to go.
Summary
Kbdcomponent across affected MDX docs.Ctrlfor Windows/Linux andCommandfor macOS where OS-specific variants are needed.⌃+Cterminal shortcuts that were already fixed in prior docs updates, and leave literal CLI output blocks unchanged.Validation
pnpm devfrom the repository root.playwright-clito verify edited routes render keyboard variants formac,windows, andlinux.playwright-clito verify visible keycaps for representative Windows, macOS, and Linux shortcuts.