Skip to content

docs(website): add keybindings guide to the docs site - #634

Merged
benvinegar merged 1 commit into
mainfrom
claude/website-keybindings-docs
Jul 29, 2026
Merged

docs(website): add keybindings guide to the docs site#634
benvinegar merged 1 commit into
mainfrom
claude/website-keybindings-docs

Conversation

@benvinegar

@benvinegar benvinegar commented Jul 29, 2026

Copy link
Copy Markdown
Member

Adds the docs-site page the [keybindings] surface was missing.

  • New Configure → Keybindings page covering the remapping model (user bindings replace defaults, exclusive chord claims, false/[] to unbind, first-in-file conflict resolution) and the chord grammar, linking the repo's docs/keybindings.md for the full built-in command table rather than duplicating it.
  • Sidebar entry in astro.config.mjs, a "Remap the defaults" pointer at the end of the keyboard-and-mouse page, and a "Remap a keyboard shortcut" common-task link on the docs index.
  • Empty changeset (docs-only).

Every behavioral claim on the page was fact-checked against src/ui/lib/keymap.ts, src/extension-api/keys.ts, and src/core/config.ts (the user-config-only rule). bun run website:build and bun run website:links pass.

(Earlier note about a sidebar conflict with #631 no longer applies — #631 now adds its own sidebar group instead of touching the Configure items, so the two merge independently.)

🤖 Generated with Claude Code

https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9

The site had no page for the [keybindings] remapping surface the README
links repo docs for; add a compact guide covering the replacement rules
and chord grammar, wire it into the Configure sidebar, and cross-link it
from the keyboard page and docs index.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hunk-web Ready Ready Preview Jul 29, 2026 12:57am

Request Review

@greptile-apps

greptile-apps Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds a keybindings configuration guide and integrates it into the documentation site.

  • Documents remapping, conflict resolution, unbinding, chord syntax, extension commands, and configuration scope.
  • Adds the guide to the Configure sidebar and links it from the docs index and keyboard-and-mouse guide.
  • Adds an empty changeset for the documentation-only update.

Confidence Score: 5/5

The documentation-only pull request appears safe to merge.

The new route and links follow existing Starlight conventions, and the documented keybinding semantics, command identifiers, chord grammar, widget interception, and user-config scope agree with the current implementation.

Important Files Changed

Filename Overview
website/src/content/docs/docs/configure/keybindings.md Adds an accurate keybindings guide whose behavioral claims and examples align with the current configuration, parsing, and command-resolution implementations.
website/astro.config.mjs Adds a correctly mapped sidebar entry for the new Starlight content route.
website/src/content/docs/docs/index.mdx Adds a valid common-task link to the new keybindings guide.
website/src/content/docs/docs/start/keyboard-and-mouse.md Adds a valid contextual link from the existing shortcut overview to the remapping guide.
.changeset/website-keybindings-docs.md Adds an intentionally empty changeset for this documentation-only change.

Reviews (1): Last reviewed commit: "docs(website): add keybindings guide to ..." | Re-trigger Greptile

@benvinegar
benvinegar merged commit d3faae0 into main Jul 29, 2026
13 checks passed
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.

2 participants