Improve parent message and documentation · bitovi/documentjs#278

(0 留言) (0 反應) (0 負責人)JavaScript (595 star) (387 fork)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:

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
議題類型: documentation
難度: 2
預計時間: 1-3 hours
活動狀態: stale
清晰度: mostly clear
前置要求: basic JavaScriptfamiliarity with DocumentJS
新手友善度: 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.