文档科普
Cocos 引擎官方文档,分为 用户手册和API参考文档,两个部分。
- 用户手册:由引擎组成员手工编写,包含引擎特性的使用流程,架构解释,概念科普等内容。
- API 参考文档:由源码注释自动生成
大家在做文档反馈时,务必说明白哪一边的文档有问题以及具体问题是什么,才能促进文档的完善。
同时,我们也提供了贡献两种方式:
- 用户手册:在对应用户手册文档页面点击编辑此页面 可以立即修改并提交PR,或者点击 提交反馈描述当前页面的文档问题。
- API 参考文档:前往引擎仓库 https://github.com/cocos/cocos-engine ,找到对应的文件,修改注释并提交 PR,即可参与到文档完善工作中。
还是说正事吧
大家好,很高兴通知大家,我们使用 VitePress 重构了文档系统。 大家可前往 https://docs.cocos.com 体验
新版文档有以下改动:
1、用 VitePress 替换了 Gitbook,使我们可以更方便地自定义主题,同时拥有更好的迭代速度和发版速度,以后文档的排版可以更加丰富。
2、Github 仓库统一使用 Master 分支作为管理,https://github.com/cocos/cocos-docs
3、响应式布局,支持电脑和手机查看
4、更加便捷的搜索界面
5、可以直接编辑此页面并提交 PR,光速参与Cocos 社区建设,获得 Contributor 荣誉头衔。
6、提交反馈按钮直接与对应文档关联,可以方便追溯文档问题。
7、支持明暗模式,满足各类人群阅读习惯
重要通知
最后,感谢大家的支持与反馈,目前文档还在继续迭代,除了页面的优化,手册文档会引入 最佳实践版块,用于收录各位开发者们的精彩分享。大家可以联系麒麟子,麒麟子会引导各位完成 PR 的提交。
希望我们能一起建设 Cocos 社区、文档、教程生态,让Cocos社区越来越好。
再次感谢!