同步操作将从 RT-Thread/docs-online 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
为加强 RT-Thread 开源社区建设,加速完善 RT-Thread 中文文档中心内容,现将文档中心编辑权限予以开放,详情参见在线文档开发介绍。欢迎社区小伙伴踊跃参与修改,提交PR。本文档中心使用 docsify 搭建。
如下是 RT-Thread 在线文档中心的主要目录说明:
development-tools:RT-Thread Studio IDE 和开发辅助工具 Env 的文档。
rt-thread-version:RT-Thread 各种版本,标准版本、nano版本、smart版本。
├─development-tools # RT-Thread 工具
│ ├─env # Env 工具
│ ├─kconfig # Kconfig 工具
│ ├─rtthread-studio # RT-Thread Studio IDE
│ │ ├─applications # 应用笔记
│ │ ├─changelog # 版本信息
│ │ ├─drivers # 驱动开发
│ │ ├─faq # 常见问题
│ │ └─um # 用户手册
│ └─scons # Scons 工具
│
├─rt-thread-version # RT-Thread 版本
│ ├─rt-thread-nano # nano 版本
│ ├─rt-thread-smart # smart 版本
│ └─rt-thread-standard # 标准版本
│ ├─application-note # 应用笔记
│ ├─development-guide # 开发指南
│ ├─programming-manual # 编程手册
│ └─tutorial # 系列教程
当发现某文档一处错误时,在该文档页面最上方,点击 “修改此文档”
跳转至该文档的 gitee 页面,点击 “编辑”
[!NOTE] 注:修改文档需要符合以下规则:
(1)修改文档段落或添加文章后,文档中包含的中英文之间需要添加空格,可以使用 vscode-pangu 插件进行格式化。
(2)为文章添加图片时,不要使用 URL 方式进行链接(URL 可能会失效),需要将图片上传至该仓库,采用相对路径进行链接,保证图片有效性。正确示范 vs 错误示范。
(3)在编辑文档中的代码段时,需要符合 RT-Thread 代码规范。
进入可编辑状态,如将 12 改为 15
拉到最下面填写 提交信息,扩展信息可以根据情况填写,无误后,点击提交审核
[!NOTE] 注:提交信息规范如下
对某文档某段描述进行更新或完善,或删除某段描述:【更新文档】更新/增加/删除了 xxx
修改文档中的错误:【修改错误】修改 xxx 为 xxx
然后等待审核即可,若审核不通过,还需要再次修改。
增加文档、删除文档则需要通过正常的 PR 流程进行提交(fork -> clone -> 分支上开发 -> commit -> PR
)。
当需要增加文档时,最重要的是判断增加的是什么类型的文档,放在什么位置,以及文档名称等,然后进行提交,增加 / 删除 文档注意更新左侧栏。
[!NOTE] 注:提交信息规范如下
增加一篇文档:【增加文档】xxxx 文档
删除一篇文档:【删除文档】删除 xxx 文档,由于 xxx 原因删除
本作品采用知识共享署名-非商业性使用 4.0 国际许可协议进行许可。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。