Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 11, 2025

This PR adds a comprehensive "Key Shortcuts" section to the README.md file to help users understand and quickly reference the custom key mappings configured in this Neovim setup.

What's Added

The new section documents:

Leader Key Configuration

  • Leader key: Space - Used as prefix for custom mappings

File Navigation Shortcuts

  • File explorer: <leader>pv (Space then pv) - Opens the file explorer
  • Telescope file search: <ctrl-p> - Fuzzy finder for files
  • Telescope live grep: <ctrl-f> - Search text content across files

Window Navigation

  • Move left: <ctrl-h> - Navigate to left split
  • Move down: <ctrl-j> - Navigate to bottom split
  • Move up: <ctrl-k> - Navigate to top split
  • Move right: <ctrl-l> - Navigate to right split

Tmux Integration

  • Tmux pane navigation: <ctrl-b> + h/j/k/l - Navigate between tmux panes in the same directions

Additional Changes

  • Updated the Table of Contents to include the new "Key Shortcuts" section
  • Added a note that these mappings are customizable in lua/shadielfares/remap.lua
  • Organized the shortcuts into logical subsections for better readability

Benefits

  • New users can quickly learn the custom shortcuts without diving into the Lua configuration files
  • Existing users have a handy reference for all key mappings
  • Clear documentation of both Neovim and tmux integration shortcuts
  • Improved overall documentation quality and user experience

The shortcuts documented match the actual key mappings defined in lua/shadielfares/remap.lua, ensuring accuracy and consistency.

This pull request was created as a result of the following prompt from Copilot chat.

Add a "Key Shortcuts" section to README.md documenting custom Neovim and tmux shortcuts.

This section should cover:

  • The leader key is set to for custom mappings.
  • File explorer shortcut: pv (Space then pv)
  • Telescope fuzzy finder shortcuts: for file search, for live grep
  • Window navigation in Neovim: <Ctrl-h/j/k/l> for left, down, up, right splits respectively
  • Tmux navigation: <Ctrl-b h/j/k/l> for pane navigation in the same directions

Add a note that these mappings are customizable in lua/shadielfares/remap.lua.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@shadielfares shadielfares marked this pull request as ready for review July 11, 2025 20:54
@shadielfares shadielfares merged commit 413b7e7 into main Jul 11, 2025
1 check passed
@Copilot Copilot AI changed the title [WIP] Add Key Shortcuts section to README.md documenting Neovim and tmux shortcuts Add Key Shortcuts section to README.md documenting custom Neovim and tmux shortcuts Jul 11, 2025
@Copilot Copilot AI requested a review from shadielfares July 11, 2025 20:57
Copilot finished work on behalf of shadielfares July 11, 2025 20:57
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