bitovi/documentjs

Improve parent message and documentation

Offen

#278 geöffnet am 10.08.2017

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (387 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (595 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie, wie DocumentJS ohne Konfiguration das übergeordnete Element errät, und dokumentieren Sie die Schritte zur Konfiguration des übergeordneten Elements.
Tech Stack
javascript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptDocumentJS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80