bitovi/documentjs

Improve parent message and documentation

Open

#278 创建于 2017年8月10日

在 GitHub 查看
 (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:

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
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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