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

Creator 3.x 文档反馈
#1

文档科普

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、响应式布局，支持电脑和手机查看
image
4、更加便捷的搜索界面
image
5、可以直接编辑此页面并提交 PR，光速参与Cocos 社区建设，获得 Contributor 荣誉头衔。
image
image
6、提交反馈按钮直接与对应文档关联，可以方便追溯文档问题。
image
7、支持明暗模式，满足各类人群阅读习惯
image

重要通知

最后，感谢大家的支持与反馈，目前文档还在继续迭代，除了页面的优化，手册文档会引入 最佳实践版块，用于收录各位开发者们的精彩分享。大家可以联系麒麟子，麒麟子会引导各位完成 PR 的提交。
希望我们能一起建设 Cocos 社区、文档、教程生态，让Cocos社区越来越好。

再次感谢！

由于新文档刚上线，难免会有细节上的不足，请大家发现后，提交ISSUE。我们会尽快处理。谢谢！

11赞
#2

https://forum.cocos.org/t/topic/158220

#3

新的文档比原文档从各方面看都比原来的好，这是一次成功的改版

1赞
#4

昨天我就发现了 :laughing:

#5

看起来更简洁了，nice

#6

image

如果这两个可以给用户自己左右调整位置就更好了

2赞
#7

文档建设，喊了3-4年了，终于落地了，改版了~ :clock12: :clock1: :clock2: :clock3: :clock4: :clock5: :clock6: :clock7: :clock8: :clock9: :clock10: :clock11:

#8

有一种熟悉感。比较好奇这个改动开了多少次会，讲了多少页ppt，建议更多花心思在文档内容建设上

#9

嗯。就是想在内容上做优化，但之前的版本太旧了，不好弄。
另外， 像 手机排版等功能也是大家一直想要的。 索性就先做了。

这个改动没有开会，我和引擎组另一个小伙伴直接抽空就做了。

1赞
#10

内容还是原来的内容，只是换了构建的框架吧

#11

这个太棒了，不管从功能、外观、可维护性来说。

#12

但是 vitepress 的默认列宽看着很难受，影响阅读体验，能否加一个全宽的选项？

  • 增大左边侧栏的宽度，否则自动换行影响体验。
    image

  • 增大内容区宽度，相比之前的太窄。

#13

这个接下来就会改，我也觉得不舒服。如果你有好的办法，也可以提一个PR，嘿嘿。

#14

部分文本字体太细了，长按预览是空页面
图片 图片

#15

如果没有人手，近期没计划改，我抽空可以看看

#16
#17

论坛置顶在手机排版上能不能优化一下。。现在经常满屏 手机上不显示置顶贴的内容预览也好的呀 或者收到最新热门那里面

#18

API的文档什么时候也改改呢

1赞
#19

文档内容更新了哪些

#20

:grinning:看着舒服多了