bitovi/documentjs

Improve parent message and documentation

Open

#278 ouverte le 10 août 2017

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)JavaScript (387 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (595 stars)
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
La demande vise à améliorer le message par défaut 'parent' lorsque DocumentJS s'exécute sans configuration. Tout d'abord, localisez où le message de la page d'index par défaut est généré (probablement dans un modèle ou un fichier JavaScript du dépôt). Ensuite, créez un guide pour configurer la propriété `parent` et ajoutez un lien vers ce guide dans le message par défaut. Pensez à examiner les fichiers de documentation existants pour assurer la cohérence de style. Aucune PR ou personne assignée n'est liée.
Stack technique
javascripthtml
Domaine
documentationdeveloper experience
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.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
basic JavaScriptfamiliarity with DocumentJS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75