Skip to content

Use Kbd component for keyboard shortcuts#1202

Merged
alistairmatthews merged 5 commits into
mainfrom
ievangelist/keyboard-shortcut-kbd-sweep
Jun 5, 2026
Merged

Use Kbd component for keyboard shortcuts#1202
alistairmatthews merged 5 commits into
mainfrom
ievangelist/keyboard-shortcut-kbd-sweep

Conversation

@IEvangelist
Copy link
Copy Markdown
Member

@IEvangelist IEvangelist commented Jun 3, 2026

Summary

  • Replace prose/raw keyboard references with the Starlight Kbd component across affected MDX docs.
  • Normalize shortcuts to use Ctrl for Windows/Linux and Command for macOS where OS-specific variants are needed.
  • Restore existing macOS ⌃+C terminal shortcuts that were already fixed in prior docs updates, and leave literal CLI output blocks unchanged.

Validation

  • Ran pnpm dev from the repository root.
  • Used playwright-cli to verify edited routes render keyboard variants for mac, windows, and linux.
  • Used playwright-cli to verify visible keycaps for representative Windows, macOS, and Linux shortcuts.
  • Did not run a build.

IEvangelist and others added 2 commits June 3, 2026 07:55
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist force-pushed the ievangelist/keyboard-shortcut-kbd-sweep branch from 5ea2256 to 8a5e92b Compare June 3, 2026 12:56
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist marked this pull request as ready for review June 3, 2026 13:32
Copilot AI review requested due to automatic review settings June 3, 2026 13:32
@IEvangelist IEvangelist requested a review from JamesNK as a code owner June 3, 2026 13:32
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 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 (including whats-new, get-started, fundamentals, dashboard, and integrations).
  • Normalized shortcut strings (notably moving toward Ctrl/Command labeling) and added Linux variants in several places.
  • Reordered/added Kbd imports 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.

Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx Outdated
Comment thread src/frontend/src/content/docs/fundamentals/networking-overview.mdx Outdated
Comment thread src/frontend/src/content/docs/ja/fundamentals/networking-overview.mdx Outdated
Comment thread src/frontend/src/content/docs/dashboard/standalone-for-python.mdx Outdated
Comment thread src/frontend/src/content/docs/dashboard/standalone-for-python.mdx Outdated
Comment thread src/frontend/src/content/docs/dashboard/standalone-for-nodejs.mdx Outdated
Comment thread src/frontend/src/content/docs/architecture/overview.mdx Outdated
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1202. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1202 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@alistairmatthews alistairmatthews left a comment

Choose a reason for hiding this comment

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

Checks out. Good to go.

@alistairmatthews alistairmatthews merged commit cbc71c5 into main Jun 5, 2026
9 checks passed
@alistairmatthews alistairmatthews deleted the ievangelist/keyboard-shortcut-kbd-sweep branch June 5, 2026 10:51
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