bitovi/documentjs

Improve parent message and documentation

Open

#278 opened on Aug 10, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (387 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (595 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
Investigate how DocumentJS guesses the parent in the absence of a config, and document the steps to configure the parent.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptDocumentJS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80