From 5e73c94f083feeaa0f06b72bc12aa83a7b280b50 Mon Sep 17 00:00:00 2001 From: Meco Man <920369182@qq.com> Date: Thu, 25 Mar 2021 01:16:41 +0800 Subject: [PATCH 1/2] =?UTF-8?q?=E5=AE=8C=E5=96=84readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2c1d422..5b1c0e1 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ ## 简介 -使用 docsify 搭建，文档中心全民参与在线预览提交，详情参见[在线文档开发介绍](#在线文档开发介绍) +为加强 RT-Thread 开源社区建设，加速完善 RT-Thread 中文文档中心内容，现将文档中心编辑权限予以开放，详情参见[在线文档开发介绍](#在线文档开发介绍)。欢迎社区小伙伴踊跃参与修改，提交PR。本文档中心使用 docsify 搭建。 ## 目录说明 -如下是RT-Thread 在线文档中心的主要目录说明： +如下是 RT-Thread 在线文档中心的主要目录说明： development-tools：RT-Thread Studio IDE 和开发辅助工具 Env 的文档。 @@ -55,7 +55,7 @@ rt-thread-version：RT-Thread 各种版本，标准版本、nano版本、smart > >（1）修改文档段落等，修改后，文档汇总包含的中英文之间需要添加空格。 > ->（2）为文章添加图片时，不要使用 URL 方式进行链接（URL 可能会失效），需要将图片上传至该仓库，保证图片有效性。 +>（2）为文章添加图片时，不要使用 URL 方式进行链接（URL 可能会失效），需要将图片上传至该仓库，采用相对路径进行链接，保证图片有效性。[正确示范](https://gitee.com/rtthread/docs-online/pulls/47/files) vs [错误示范](https://gitee.com/rtthread/docs-online/pulls/44/files)。 > >（3）在编辑文档中的代码段时，需要符合 [RT-Thread 代码规范](https://github.com/RT-Thread/rt-thread/blob/master/documentation/coding_style_cn.md)。 > @@ -100,7 +100,8 @@ rt-thread-version：RT-Thread 各种版本，标准版本、nano版本、smart - 文档命名使用英文，有必要时候使用中杠。 - 每篇文档使用一个 figures 文件夹。 - 文档内容注意中英文之间增加一个空格。 -- 网站文档已开启缓存，测试没有效果时，请使用 CTRL+F5 强制刷新页面，或让浏览器进入 无痕模式 +- 网站文档已开启缓存，测试没有效果时，请使用 CTRL+F5 强制刷新页面，或让浏览器进入无痕模式。 +- 标点符号需要使用中文标点符号；若出现连续、段落性英文，可以在句子间或该段落使用英文标点符号。 ## 许可协议 -- Gitee From 4909f9e9a488000c93d08b618761e0c5bbb26f4e Mon Sep 17 00:00:00 2001 From: Meco Man <920369182@qq.com> Date: Thu, 25 Mar 2021 01:28:02 +0800 Subject: [PATCH 2/2] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=20=E8=A7=86=E9=A2=91?= =?UTF-8?q?=E6=95=99=E7=A8=8B=E9=93=BE=E6=8E=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../rt-thread-standard/development-guide/github/github.md | 1 + 1 file changed, 1 insertion(+) diff --git a/rt-thread-version/rt-thread-standard/development-guide/github/github.md b/rt-thread-version/rt-thread-standard/development-guide/github/github.md index 17e0eba..7fec3b6 100644 --- a/rt-thread-version/rt-thread-standard/development-guide/github/github.md +++ b/rt-thread-version/rt-thread-standard/development-guide/github/github.md @@ -149,3 +149,4 @@ git pull rtt master ## 参考资料 * 若对贡献代码还有不明白的地方，可以参考 Git 官方中文文档[《GitHub - 对项目做出贡献》](https://git-scm.com/book/zh/v2/GitHub-%E5%AF%B9%E9%A1%B9%E7%9B%AE%E5%81%9A%E5%87%BA%E8%B4%A1%E7%8C%AE)章节。 +* 教学视频：[从0教你如何给RT-Thread贡献代码](https://www.bilibili.com/video/BV1gr4y1w7yX) -- Gitee