nvim-tree / nvim-tree/nvim-tree.lua

Mappings/functionality discoverability discussion

Open
#2,710 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
8.6k
Forks
639
Avg merge
1d 14h
Merged PRs (30d)
2

Description

Since you touched on a topic of keybindings, currently it's hard to get a sense of what's possible.

  1. The help panel is hidden under "g?" keybinding by default, and only when nvim-tree updated its way to change keybindings, I discovered that there's a help panel (I was smashing ? and since it did nothing, I just assumed there's no help panel).
  2. As a user, you think everything useful (or even possible) is in this panel.

So I think the ideal solution would be to:

  1. Make it clear that g? is a default help panel keybinding. Show "g? - help" somewhere in nvim-tree panel or make it visible in readme.
  2. Show every possible API command in this help panel, even if it has no keybinding + keybinding if there's one
  3. Since there are lots of commands, it would be great to group them

This way, you can have minimal keybinding config and it will be extremely easy to copy-paste api function to your on_attach without reading :h nvim-tree

Originally posted by @DeH4er in https://github.com/nvim-tree/nvim-tree.lua/issues/2706#issuecomment-1999552699

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing g? help panel, the README, the available API commands, and the on_attach configuration referenced in the issue. Determine how keybindings and unbound commands are currently represented, then define the grouping and display behavior before implementing the proposed discoverability improvements.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.