bitovi/documentjs

Improve parent message and documentation

Aperta

#278 aperta il 10 ago 2017

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (387 fork)batch import
documentationhelp wanted

Metriche repository

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

Descrizione

I assume that DocumentJS should be able to create something useful out of the box. When I add DocumentJS to my project, and run it without defining a config, I get the following index page built:

image

It would be helpful to create a guide for configuring the parent and linking to it anytime DocumentJS has to guess the parent.

Guida contributor

Direzione di ricerca
Indaga come DocumentJS indovina il genitore in assenza di una configurazione e documenta i passaggi per configurare il genitore.
Tech stack
javascript
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.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaScriptDocumentJS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80