Skip to content

docs(nvim): add documentation for neovim#3

Open
Prakhar1808 wants to merge 4 commits intoLilSuperUser:mainfrom
Prakhar1808:docs/nvim-documentation
Open

docs(nvim): add documentation for neovim#3
Prakhar1808 wants to merge 4 commits intoLilSuperUser:mainfrom
Prakhar1808:docs/nvim-documentation

Conversation

@Prakhar1808
Copy link
Copy Markdown
Contributor

@Prakhar1808 Prakhar1808 commented Apr 11, 2026

Overview

this PR adds documentation for the nvim dotfiles (config)
majorly all keymaps needed to use the nvim config

Screenshot (Preview)

image

Note For Maintainers

do tell if any changes are to be made or any specific keymaps need to be added or removed

@Prakhar1808 Prakhar1808 marked this pull request as ready for review April 14, 2026 14:28
Copy link
Copy Markdown
Owner

@LilSuperUser LilSuperUser left a comment

Choose a reason for hiding this comment

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

We need a few changes in the keymap documentation:

  • I noticed that you have missed some keymaps that exists in the config. Please add them.
  • We should also add a Mode column (to be verbose about what mode the user has to be in to use the keymap
  • I noticed one duplicate entry under the General Section, 1st and the 3rd keymaps are same. Adding a column for Mode would fix it.

Lastly, the current structure makes it hard to navigate cause the user would have to scroll a lot to find the desired keymap.

Maybe we should organize it as a webpage or adding an index/table of contents at the top. The main idea is that it should look like a cheatsheet.

Also, I’ve pushed some changes to main, please pull and rebase your branch on top of it.

@Prakhar1808
Copy link
Copy Markdown
Contributor Author

thanks for the input, will do!

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