[PR #867] [MERGED] docs: fix keybinds documentation to match actual config schema #9732

Closed
opened 2026-02-16 18:14:04 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/anomalyco/opencode/pull/867
Author: @danyel117
Created: 7/10/2025
Status: Merged
Merged: 7/16/2025
Merged by: @jayair

Base: devHead: patch-1


📝 Commits (4)

  • 7615758 docs: fix keybinds documentation to match actual config schema
  • 781092c Update keybinds.mdx to add the missing
  • 3a58afe Update keybinds.mdx to group commands by their categories
  • 3859491 Update keybinds.mdx to add new lines between command categories

📊 Changes

1 file changed (+19 additions, -5 deletions)

View changed files

📝 packages/web/src/content/docs/docs/keybinds.mdx (+19 -5)

📄 Description

The keybinds documentation was significantly out of sync with the actual configuration schema, causing confusion for users trying to customize their keybinds.

Issues Fixed:

Incorrect Key Names:

  • Changed help to app_help to match schema
  • Updated messages_previous/messages_next bindings from ctrl+alt+k/ctrl+alt+j to ctrl+up/ctrl+down
  • Corrected app_exit default from ctrl+c,<leader>q to ctrl+c,q

Missing Keybinds:

Added documentation for keybinds that were in the schema but missing from docs:

  • switch_mode (tab) - Switch between different modes
  • session_unshare (u) - Unshare current session
  • file_list (f) - List files
  • file_close (esc) - Close file
  • file_search (/) - Search file
  • file_diff_toggle (v) - Toggle between split and unified diff view
  • messages_layout_toggle (p) - Toggle layout
  • messages_copy (y) - Copy message
  • messages_revert (r) - Revert message

Removed Non-existent Keybinds:

  • Removed history_previous and history_next which don't exist in the schema

Format Improvements:

  • Updated example JSON to use actual schema defaults instead of leader key combinations
  • Added comprehensive documentation section explaining all available keybinds with descriptions
  • Maintained the leader key explanation but corrected the examples

This brings the documentation in line with the actual implementation and provides users with accurate information for customizing their keybinds.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/anomalyco/opencode/pull/867 **Author:** [@danyel117](https://github.com/danyel117) **Created:** 7/10/2025 **Status:** ✅ Merged **Merged:** 7/16/2025 **Merged by:** [@jayair](https://github.com/jayair) **Base:** `dev` ← **Head:** `patch-1` --- ### 📝 Commits (4) - [`7615758`](https://github.com/anomalyco/opencode/commit/761575813ae887af64d6fda10e883903d22dfb96) docs: fix keybinds documentation to match actual config schema - [`781092c`](https://github.com/anomalyco/opencode/commit/781092c89bd1efdfcbd4f8d9340ea4917ce09a28) Update keybinds.mdx to add the missing <leader> - [`3a58afe`](https://github.com/anomalyco/opencode/commit/3a58afe648ec8db441d88c34bf2660d420646f4e) Update keybinds.mdx to group commands by their categories - [`3859491`](https://github.com/anomalyco/opencode/commit/385949171936ee8f12ea80270a2809b9798f6e3d) Update keybinds.mdx to add new lines between command categories ### 📊 Changes **1 file changed** (+19 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `packages/web/src/content/docs/docs/keybinds.mdx` (+19 -5) </details> ### 📄 Description The keybinds documentation was significantly out of sync with the actual configuration schema, causing confusion for users trying to customize their keybinds. ## Issues Fixed: ### Incorrect Key Names: - Changed `help` to `app_help` to match schema - Updated `messages_previous`/`messages_next` bindings from `ctrl+alt+k`/`ctrl+alt+j` to `ctrl+up`/`ctrl+down` - Corrected `app_exit` default from `ctrl+c,<leader>q` to `ctrl+c,q` ### Missing Keybinds: Added documentation for keybinds that were in the schema but missing from docs: - `switch_mode` (tab) - Switch between different modes - `session_unshare` (u) - Unshare current session - `file_list` (f) - List files - `file_close` (esc) - Close file - `file_search` (/) - Search file - `file_diff_toggle` (v) - Toggle between split and unified diff view - `messages_layout_toggle` (p) - Toggle layout - `messages_copy` (y) - Copy message - `messages_revert` (r) - Revert message ### Removed Non-existent Keybinds: - Removed `history_previous` and `history_next` which don't exist in the schema ### Format Improvements: - Updated example JSON to use actual schema defaults instead of leader key combinations - Added comprehensive documentation section explaining all available keybinds with descriptions - Maintained the leader key explanation but corrected the examples This brings the documentation in line with the actual implementation and provides users with accurate information for customizing their keybinds. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-16 18:14:04 -05:00
yindo closed this issue 2026-02-16 18:14:04 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#9732