Improve documentation with default lua settings
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- lua
- Ambito
- documentation
Direzione di ricerca
Start with the documentation's NeoVim section and inspect the existing configuration guidance and available default settings. Compare it with the linked plugin examples, then document the Lua parameters and their defaults in a code snippet so users can configure the plugin from the docs.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Hello @TaDaa
Found this plugin via your reply on Reddit. This is great that you keep maintaining this very usueful functionality.
Installed it today and all works fine with default settings.
Although I would like to raise an documentation issue regarding configuration, since I found current state of docs a bit messy,
comparing to other NeoVim plugins.
Usually plugins are providing a list of all lua parameters with their default values as lua code snippet,
example from similar plugins
- https://github.com/miversen33/sunglasses.nvim?tab=readme-ov-file#configuration
- https://github.com/levouh/tint.nvim?tab=readme-ov-file#gear-setup
Or from some other plugins
- https://github.com/lewis6991/gitsigns.nvim?tab=readme-ov-file#installation--usage
- https://github.com/nvim-lualine/lualine.nvim?tab=readme-ov-file#usage-and-customization
It would be great if you could adjust docs' NeoVIm section to provide similar lua code snippet.
- Lingua principale
- Lua
- Stelle
- 677
- Fork
- 13
- Merge medio
- 10g 17h
- PR unite (30g)
- 1
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di TaDaa/vimade
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 38/100
-
Idea: highlight part of a fileForse di nuovo libera @TaDaa l’ha presa 649 giorni fa e non c’è nessuna pull request aperta. Aperta
Tutte le issue di TaDaa/vimade
Issue simili
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
eugenioenko/ttt#919 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Profiler (Remotery) leaks a socket for every connection that fails the WebSocket handshakeForse già presa @rthery l’ha presa oggi. Apertatriage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Mosquito: LOOP_ANT_LOCK reads the IFF detonator coverForse già presa @cbass2404 l’ha presa oggi. ApertaMosquito
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
DCS-Skunkworks/dcs-bios#1925 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 Meno di un'ora Idoneità per principianti 80/100
mason-org/mason.nvim#2117 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
mailcow/mailcow-dockerized#7518 ·
I maintainer di solito rispondono entro 1 giorno