[欢迎提交 PR 和 issue]Cocos Creator 新版用户手册上线!

需要大家列出觉得要加粗的关键点。提交issue,这边会安排处理的。

嗯。格式问题,已经处理了。谢谢反馈。

image

这搜索是不是有问题呢?比如我这里搜计时器搜不到计时器章节了

建议补充一下 Assembler 使用的相关官方教程,这一块完全是空白的

特别是看到这个定义,这样子写,还有必要定义 interface 吗 :sweat_smile:

image

image
1、基础知识是不是应该比新手上路更往左靠?
2、点击一次新手上路,再点击一次新手上路,子标题没有收回去,感觉收回去会好一些。
3、点击一次新手上路,点击右边的箭头收回去了,再点击新手上路,无法展开了。

嗯嗯。谢谢反馈,侧边栏样式会优化的。

@All,新版本已处理完毕。 大家帮忙测试几个东西。:
1、站内站外链接是否有出现 404 问题。 如果有,还请帮忙提 issue
2、是否有排版问题(PC和手机上分开提)
3、搜索功能是否OK。

1赞

刚刚处理了50个issue。 大家如果发现了文档有什么问题,或者好的建议的,麻烦提一下 issue:
https://github.com/cocos/cocos-docs/issues

如果想知道文档更新了什么,可以查看文档的 commits:
https://github.com/cocos/cocos-docs/commits/master/

1赞

image 哈哈哈哈

内容跟顶部导航栏重叠。新文档目录太宽,同样的导航栏太高,笔记本一屏下来内容显示区域就变少了
image

你是什么浏览器,什么电脑。 我们看看如何重现。

image
发现个小问题 :laughing: :laughing: :laughing:

点“编辑此页面”,可以直接改了提交PR,谢谢

1赞

我也发现新版本的文档搜索结果,没有旧版本的搜索结果多,提供准确的关键字还存在搜不到的情况 :joy:

感觉是这类 Vuepress、Docusaurus 框架自带搜索的通病,只要是这些框架做的文档网站,搜起来都不怎么得劲。

经过研究发现,VitePress 的中文搜索确实很弱,英文是非常OK的。
我们研究一下如何接入另一个中文搜索功能,谢谢反馈!

文档反馈打开eassing Api 404 404页面

新版的手册页面很好看,是动态页面,感觉是 Cocos 历史以来最好的一个版本,之前王楠用的 gitbook 最古老的版本,能撑到今天太不容易了。提个建议,引擎下载应该引导到 Cocos Creator 下载 - 轻量高效的开发引擎 页面。

文档真的很繁琐,要处理各种链接的转换、permanent link、404,搜索的权重要人工调优,要同时维护新老版本,现成的框架基本都要定制或者二开。看看 Creator 的 API 有多少个版本就知道了。最早 API 一样是 gitbook 用 markdown 转的,只能算是能用。

最恶心的应该是 3.0,当时用的第三方的,问题一大堆。到了 3.3 编辑器团队终于推翻重撸了一个版本,可以正常迭代维护了。

从 3.4 开始,Cocos 终于有了 PM 和设计师。把 API 文档从零设计了一次,细节都考虑到了,使用后端进行搜索,一直延用到今天。


顺便吐槽一下,当时有一个新来的前端,设计稿不还原就算了,功能做的像屎一样,细节没几个能看,浪费了我和设计师好多时间。后来我第一个就把他干掉了。

其他都好说,就是现在版本中文搜索很难用

没有产品走查,没有 QA 验收,研发能自驱捣鼓成这样很不容易了,你是没见过我吐槽的那个小哥做的东西。如果不能包容过错,那研发小哥干脆啥也别干躺平,反正多做多错,不做也不会少拿钱,公司也开不了,是吧。