nvim-tree / nvim-tree/nvim-tree.lua
Migrate To docgen.nvim
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 8.6k
- Forks
- 639
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 2
Description
https://github.com/jamestrew/docgen.nvim is a documentation generator that is quite similar to Nvim's, using the same luacats internals. It's written by the telescope author and is under active development / use.
It generates documentation that is nearly the same, with a few QOL fixes such as automatic links to classes/functions.
This is desirable as Nvim's is not public API and has changed a few times e.g. https://github.com/nvim-tree/nvim-tree.lua/pull/3314
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked docgen.nvim project and the repository's current Neovim documentation-generation setup. Confirm how its LuaCATS internals and generated output compare, then migrate the project so documentation remains equivalent while gaining the described automatic class and function links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100