Migrate To docgen.nvim
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Refactorisation
- Clarté
- À clarifier
- Activité
- Calme
- Stack technique
- lua
- Domaine
- documentation, tooling
Piste de recherche
Commencez par examiner le projet docgen.nvim lié et la configuration actuelle du dépôt pour la génération de la documentation de Neovim. Vérifiez en quoi ses composants internes de LuaCATS et la sortie générée diffèrent, puis migrez le projet afin que la documentation reste équivalente tout en bénéficiant des liens automatiques décrits pour les classes et les fonctions.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
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
- Langage dominant
- Lua
- Étoiles
- 8.7k
- Forks
- 642
- Merge moyen
- 17 h 10 min
- PR mergées (30 j)
- 5
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de nvim-tree/nvim-tree.lua
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
nvim-tree/nvim-tree.lua#3362 · 1 commentaire ·
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
nvim-tree/nvim-tree.lua#3361 ·
-
Use vim.Option getters and setters instead of directly settingPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
nvim-tree/nvim-tree.lua#3357 · 1 commentaire ·
-
Migrate To vim.packOuvertedocumentation PR please
Difficulté 1/5 Moins d'une heure Accessibilité débutants 65/100
nvim-tree/nvim-tree.lua#3179 · 6 commentaires ·
-
bug PR please reproduced
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
nvim-tree/nvim-tree.lua#3368 · 3 commentaires ·
Toutes les issues de nvim-tree/nvim-tree.lua
Issues similaires
-
test-net.lua fails on linuxPeut-être pris @PatrickDahlin l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour
-
agent-review-finding
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
codymikol/multiverse.nvim#393 ·
Les mainteneurs répondent en général sous 1 jour
-
[alt:V] discontinuedOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
pterodactyl/game-eggs#665 ·
Les mainteneurs répondent en général sous 1 jour
-
`head_templates` missing for `{{aii-intj}}` and `{{aii-propn}}` (not matched by `HEAD_TAG_RE`)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
tatuylonen/wiktextract#1731 · 1 commentaire ·