bitovi / bitovi/documentjs

Improve parent message and documentation

Open
#278 0 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
JavaScript
Stars
598
Forks
371
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](https://user-images.githubusercontent.com/2633542/29178009-478372de-7dbe-11e7-90b0-7008a15bb3ab.png)

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

No contributing guide indexed for this repository

Research direction

Run DocumentJS without a configuration to reproduce the generated index page shown in the issue. Determine where the parent configuration is documented and where DocumentJS guesses a parent, then add a guide and link to it whenever that fallback occurs; done means the guide explains configuring parent and the generated output points readers to it.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.