bitovi/documentjs

Improve parent message and documentation

Ouverte

#278 ouverte le 10 août 2017

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (387 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (595 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Recherchez comment DocumentJS devine le parent en l'absence de configuration et documentez les étapes pour configurer le parent.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptDocumentJS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80