bitovi/documentjs

Improve parent message and documentation

Open

#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 star)
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
La richiesta chiede di migliorare il messaggio predefinito 'parent' quando DocumentJS viene eseguito senza una configurazione. Innanzitutto, individuare dove viene generato il messaggio della pagina di indice predefinita (probabilmente in un modello o file JavaScript all'interno del repository). Quindi, creare una guida per configurare la proprietà `parent` e aggiungere un collegamento a quella guida nel messaggio predefinito. Considerare di esaminare i file di documentazione esistenti per coerenza stilistica. Non sono presenti PR o assegnatari collegati.
Tech stack
javascripthtml
Dominio
documentationdeveloper experience
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.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
basic JavaScriptfamiliarity with DocumentJS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75