Migrate To docgen.nvim
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 重构
- 描述清晰度
- 需要澄清
- 活跃度
- 冷清
- 技术栈
- lua
- 领域
- documentation, tooling
调研方向
首先检查链接的 docgen.nvim 项目以及 repository 当前的 Neovim 文档生成设置。确认其 LuaCATS 内部实现与生成的输出之间的对应情况，然后迁移该项目，使文档保持等效，同时获得所述的类和函数自动链接。
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- Lua
- 星标
- 8.7k
- 派生
- 639
- 平均合并
- 8 小时 25 分钟
- 30 天内合并 PR
- 3
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nvim-tree/nvim-tree.lua 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
nvim-tree/nvim-tree.lua#3362 · 1 条评论 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 72/100
nvim-tree/nvim-tree.lua#3361 ·
-
Use vim.Option getters and setters instead of directly setting可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
nvim-tree/nvim-tree.lua#3357 · 1 条评论 ·
-
documentation PR please
难度 1/5 1 小时以内 新手友好度 65/100
nvim-tree/nvim-tree.lua#3179 · 6 条评论 ·
-
upstream: neovim
难度 4/5 3-5 天 新手友好度 38/100
nvim-tree/nvim-tree.lua#3344 · 1 条评论 ·
查看 nvim-tree/nvim-tree.lua 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
mogenson/PaperWM.spoon#178 ·
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 85/100
-
severity: low
难度 2/5 1-3 小时 新手友好度 68/100
luainkernel/lunatik#1876 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 91/100
-
bug ready ticket
难度 2/5 1-3 小时 新手友好度 78/100
Domktorymysli/vclu#5 ·