[Feature] 官方文档几千年没有更新了,对新手非常不友好!

未关闭
#11,230 5 条评论 7 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
冷清
领域
documentation

调研方向

该 issue 泛指官方 RT-Thread 文档,包括文件路径、功能变更和 menuconfig 界面,但没有指定具体的文档文件或测试。首先将当前文档与对应的 RT-Thread 发布版本进行比较;完成这项工作需要更新已发现的不一致之处,但范围尚未限定。

由索引模型根据 Issue 内容生成。

描述

Describe problem solved by the proposed feature

新手想要入门学习 RT-Thread,打开 RT-Thread 官方文档并按照文档的说明一步步操作,发现很多地方跟实际根本对不上,节节挫败,越学越想放弃。

Describe your preferred solution

希望每次 RT-Thread 升级后,都相应地更新一下官方文档,例如某些文件的存在路径,某些功能的变化,某些 menuconfig 界面的变化等。

Describe possible alternatives

No response

主要语言
C
星标
12.4k
派生
5.5k
平均合并
3 天 7 小时
30 天内合并 PR
79

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

RT-Thread/rt-thread 的其他 Issue

查看 RT-Thread/rt-thread 的全部 Issue

相似的 Issue

更多 C Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。