README overhaul - Githubissues

nvimtools / hydra.nvim

Create custom submodes and menus

MIT License

145 stars 8 forks source link

README overhaul #5

Closed benlubas closed 10 months ago

benlubas commented 10 months ago

I'm willing to take this on, possibly tomorrow. There's a few main things that I want to do:

Keep the intro b/c it's absolutely amazing, whoever wrote that for the original emacs hydra... hats off to ya
Completely remove the examples, and put them in the wiki instead. Point to the wiki from the README
Majorly re-write the Hydra({}) documentation... It's currently very hard to navigate, easy to get lost in, and hard to see what's important.
Potentially reorganize some of the other parts

miversen33 commented 10 months ago

Writing documentation is hard, godspeed lol.

I would highly advise we do this in sections, and a primary goal here would be that the readme can be easily converted to vimdoc. Anything that doesn't really fit in the vim help should, IMO be migrated to the wiki (with links as needed in the README).