-
Notifications
You must be signed in to change notification settings - Fork 4k
docs: fix keybinds documentation to match actual config schema #867
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
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 is helpful, thank you! curious though, i'm not seeing these:
is it confusing to remove the |
|
I agree about the
Sorry, i added those initially and then deleted them because they felt redundant. Here they are anyways. Let me know if you'd like me to add them. Available KeybindsGeneral
Editor
Session Management
Tools and UI
File Operations
Input Controls
Message Navigation
Thanks! |
|
I guess file_search is now @ But otherwise this is useful. Maybe we could add these descriptions as comments to the code snippet we have in the doc. And separate them into the sections you have here by adding new lines between them? |
|
I put those new lines between the categories in the commands. I think those descriptions could be added to the code snippets. I can open another PR for that.
I still see |
oh, actually, the |
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:
helptoapp_helpto match schemamessages_previous/messages_nextbindings fromctrl+alt+k/ctrl+alt+jtoctrl+up/ctrl+downapp_exitdefault fromctrl+c,<leader>qtoctrl+c,qMissing Keybinds:
Added documentation for keybinds that were in the schema but missing from docs:
switch_mode(tab) - Switch between different modessession_unshare(u) - Unshare current sessionfile_list(f) - List filesfile_close(esc) - Close filefile_search(/) - Search filefile_diff_toggle(v) - Toggle between split and unified diff viewmessages_layout_toggle(p) - Toggle layoutmessages_copy(y) - Copy messagemessages_revert(r) - Revert messageRemoved Non-existent Keybinds:
history_previousandhistory_nextwhich don't exist in the schemaFormat Improvements:
This brings the documentation in line with the actual implementation and provides users with accurate information for customizing their keybinds.