Mappings/functionality discoverability discussion about nvim-tree.lua HOT 10 OPEN

Let's discuss it here, to keep linked PR clean.

I think issue here is of a documentation rather than anything else.
Being an Neovim plugin and having the same target audience I am pretty happy to assume certain level of IT-related knowledge, mainly ability to find and read documentation.

from nvim-tree.lua.

One thing I've always wanted (out of scope here) is the ability to press <CR> on the focused entry in help to execute it.

from nvim-tree.lua.

It's true. My point is to make it easier to see all useful features to set/change a keybinding. Setting/changing a keybinding is probably one of the most common config changes people would make.

I doubt that someone will ever notice that they can use toggle_enable_filters or any other API feature which currently has no keybinding

And since there's already a help panel, why not make it better?

Here's what comes to mind

nvim-tree mappings                   exit: q


Navigation
  not assigned  Next Sibling         api.node.navigate.sibling.next
  <             Previous Sibling     api.node.navigate.sibling.prev
...

Files
  d             Delete               api.fs.remove
...

from nvim-tree.lua.

I am not agains showing all available api calls in help window. If grouped together, as you showed above, it's actually quite nice and useful.

I would not really like any statement regarding existance of g? in nvim-tree's window, because next person will want an option to remove it (that person could as well be me) and we will have to yet another option. We can improve documentation/readme to make it more obvious though.

from nvim-tree.lua.

Yeah, I would definitely disable g? - help line in config since it clutters the view. The idea is to get this knowledge somehow to the person who installs nvim-tree for the first time. One crazy idea is to name the buffer "g? - help" but it's super hacky and just asks for trouble

from nvim-tree.lua.

I am not agains showing all available api calls in help window. If grouped together, as you showed above, it's actually quite nice and useful.

Yes please - it could be another s toggle or two.

I would not really like any statement regarding existance of g? in nvim-tree's window, because next person will want an option to remove it (that person could as well be me) and we will have to yet another option. We can improve documentation/readme to make it more obvious though.

Yes. Users tend to get upset about that sort of thing.

The key is noted in help nvim-tree-quickstart-help nvim-tree-mappings nvim-tree-mappings-default and Readme Quick Start Help

If there was some way of showing it the first time the user runs the tree I would be very happy, however it's hard to persist any sort of state and... once again... users tend to get upset about that.

from nvim-tree.lua.

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).

The first thing I did when I started to use nvim-tree was bind ? to help.

There's not much consistency among plugins - some use g? some use ? some use both.

Could we add ? @gegoune ?

from nvim-tree.lua.

All the rest? Yes please!

from nvim-tree.lua.

One thing I've always wanted (out of scope here) is the ability to press <CR> on the focused entry in help to execute it.

Good idea!
And some other key to open help for it?

Could we add ?

This is default mapping (search backwards), hence g? became popular. Probably wouldn't want to go this way.

from nvim-tree.lua.

This is default mapping (search backwards), hence g? became popular. Probably wouldn't want to go this way.

Fair enough. I don't think we can really add anything further around discovery.

from nvim-tree.lua.