征集 Creator 官方文档的内容的修改建议

亲爱的小伙伴们,Creator 最近一段时间一直有在完善 使用文档,我们的布道师 @yufang.wu 萌妹子会在之后继续投入力气来改进现有的文档体系。
为了更好的贴近用户需求,现公开征集修改建议,欢迎反馈。

可以反馈的点:

  • 内容缺失,需要增加哪方面的文档
  • 整体结构问题,如大纲安排、篇幅问题、学习曲线……
  • 内容上的 bug,如错别字、歧义、链接无法跳转、排版问题、中英文用词不当……
  • 描述上的问题,如语文老师死得早……
  • ……

回复时请尽量说清楚问题在哪,最好能附上链接,以及改进建议。
感谢大家,限于时间可能无法一一回复,但是我们一定会虚心听取你们的意见。

为了节约大家时间,请不要在这里回复和文档内容本身无关的任何话题,其它话题请另外发帖讨论。

另外,我们所有文档使用 markdown 编写,开源在 https://github.com/cocos-creator/creator-docs ,大家也可以直接到上面提 issue 或者 pull request。

支持,这个优先级必须很高

先把API没翻译的翻译了,不要出现dataHandler Handle data这样没意义的解释。

8赞

来一篇Creator的shader新手入门介绍吧

6赞

完善Api说明,最好是加上实例说明。

5赞

构建模板那个,是真的坑。我自己摸索了好久才搞定的。因为没有说开了md5之后怎么处理。

现在的api文档真的难用的要命,比如你搜个cc.jsb竟然没有。。。

5赞

点击这个,进入文档网页的时候
文档左边导航栏,加载太慢了啊。。。
不知道其他人是不是这样。。。

2赞

比下面的文档再详细点全面点就可以了
->文档

我觉得曾经打算认真研究文档的人,现在都已经放弃文档直接看源码去了
所以看起来并没有很多人在给文档提建议

我曾经想用BoxCollider,看文档完全无用

1赞

api文档太乱

1赞

RenderTexture,DrawNode文档木有

写了个TS版本的捕鱼达人,希望能收录进demo
官方文档是很有很多欠缺的,踩了很多坑

5赞

希望出几篇h5接第三方文档的教程。。接广告好麻烦啊。。

1赞

1、jsb 接口内容,现在完全是空白

2、每个接口、属性可用的 SDK 版本;

3、文档最好能说明一些已知的 issue.

还有用什么样的sdk组合编译适配性兼容性最好,最大程度避免闪退。

文档上要有具体的实例,和完整的Demo,API解释方面的最好要有例子(可以不用翻译,但必须得有例子),还要包括有些要注意的地方等等!反正我们希望看到Creator在进步,而不是在倒退!个人还是蛮期待cocosCreator后续的发展的,看好你们!

3赞

官网的API文档那个按钮我大概点了2年了,每次进去都是空白。
加油。