bitovi/documentjs

Improve parent message and documentation

Open

#278 opened on Aug 10, 2017

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

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

Tech stack
javascripthtml
Domain
documentationdeveloper experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic JavaScriptfamiliarity with DocumentJS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue requests improving the default 'parent' message when DocumentJS runs without a config. First, locate where the default index page message is generated (likely in a template or JavaScript file within the repository). Then, create a guide for configuring the `parent` property, and add a link to that guide in the default message. Consider examining existing documentation files for style consistency. No linked PRs or assignees are present.