bitovi/documentjs

Improve parent message and documentation

Open

#278 opened on 2017年8月10日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)JavaScript (595 stars) (387 forks)batch import
documentationhelp wanted

説明

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.

コントリビューターガイド

技術スタック
javascripthtml
領域
documentationdeveloper experience
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
basic JavaScriptfamiliarity with DocumentJS
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
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.
Improve parent message and documentation · bitovi/documentjs#278 | Good First Issue