woutdp/live_svelte

Add documentation to HexDocs instead of readme

Open

#35 aperta il 21 apr 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Elixir (73 fork)batch import
documentationgood first issue

Metriche repository

Star
 (1646 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

The documentation is getting a bit unwieldly, so let's move most things over to HexDocs and keep just the bare minimum in the README.md

Guida contributor

Direzione di ricerca
Esamina il README esistente e identifica le sezioni da spostare su HexDocs, quindi crea i file di documentazione appropriati per i moduli.
Tech stack
elixir
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Elixir
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85