Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Migrate To docgen.nvim

Aberta
#3,330 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Refatoração
Clareza
Precisa de esclarecimento
Status de atividade
Pouca atividade
Stack de tecnologia
lua

Direção de pesquisa

Comece revisando o projeto docgen.nvim vinculado e a configuração atual do repositório para geração da documentação do Neovim. Confirme como os componentes internos do LuaCATS e a saída gerada se comparam e, em seguida, migre o projeto para que a documentação continue equivalente, passando também a contar com os links automáticos descritos para classes e funções.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

documentation

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

Linguagem predominante
Lua
Estrelas
8.7k
Forks
643
Merge médio
2d 4h
PRs com merge (30d)
5

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de nvim-tree/nvim-tree.lua

Todas as issues de nvim-tree/nvim-tree.lua

Issues semelhantes

Mais issues de Lua

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.