Migrate To docgen.nvim
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Refactor
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- lua
- Domain
- documentation, tooling
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.
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
- Dominant language
- Lua
- Stars
- 8.7k
- Forks
- 638
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from nvim-tree/nvim-tree.lua
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
nvim-tree/nvim-tree.lua#3357 · 1 comment ·
-
Migrate To vim.packOpendocumentation PR please
Difficulty 1/5 Under an hour Newbie friendliness 65/100
nvim-tree/nvim-tree.lua#3179 · 6 comments ·
-
upstream: neovim
Difficulty 4/5 3-5 days Newbie friendliness 38/100
nvim-tree/nvim-tree.lua#3344 · 1 comment ·
-
Experimental Features: `session_restore_nvim`May be free again @igorlfs claimed this 85 days ago, and no pull request is open. Open
nvim-tree/nvim-tree.lua#3343 · 3 comments · 1 assignee ·
-
feature request
Difficulty 5/5 Over a week Newbie friendliness 35/100
nvim-tree/nvim-tree.lua#3341 · 1 comment ·
All issues in nvim-tree/nvim-tree.lua
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 2 days
-
ai-authored
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Data Correction Forever Needs testing/reproduction
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Questie/Questie#7941 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
remote remote-plugin
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day