Better expose mappings to the user

[przepompownia]

README file partially describes local mappings on sections, but I see more possibilities in keymaps.lua.

Maybe README needs to improve, but following (for example) diffview's approach (probably one window divided by sections) would be helpful in remembering.

[igorlfs]

Hello!

Thanks for the suggestion.

but following (for example) diffview's approach (probably one window divided by sections) would be helpful in remembering.

Crafted a proof of concept here, using Markdown. It looks like this:

By default, it's bound to g?, as it's common practice among other plugins. Let me know what do you think.

Maybe README needs to improve,

Yeah, the README is getting clunky (intimidating, even). Of course, that's not necessarily related to this matter, but at this point, I'm starting to think that a web page would be a better fit for the documentation as a whole. I'll be sure to properly document the keymaps when building this migration.

[przepompownia]

In general it looks nice! g? seems to not conflict with any known global keymap. rg -g '*.lua' -n --no-ignore --column --no-heading --color=never -- '\bg\?' . (| nvim -q -) in my environment shows six other plugins using it (not always for show mappings).

One missing minor thing seems to be configurable window border (I have empty global winborder, but would like to configure help window separately).

[przepompownia]

api.nvim_win_close needs to check before call if the help window still exist (I use nmap for :fclose).

[igorlfs]

api.nvim_win_close needs to check before call if the help window still exist (I use nmap for :fclose).

Ah, I think that's because I forgot to make q a local mapping. Can you give it a try now?

One missing minor thing seems to be configurable window border2

Done!

[przepompownia]

Thanks for both changes!

[igorlfs]

Closed by #62.