moscajs/mosca

Write documentation in plain markdown

Aperta

#501 aperta il 18 giu 2016

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (498 fork)github user discovery
help wanted

Metriche repository

Star
 (3186 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Currently the documentation is written inlined in the code, using a (now-broken) documentation generation system.

We should rewrite this into a doc folder just using "plain" markdown.

Guida contributor

Direzione di ricerca
Esamina la documentazione inline esistente nel codice sorgente, quindi crea una nuova cartella 'doc' con file Markdown semplici che replicano il contenuto in modo strutturato.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90