RT-Thread / RT-Thread/rt-thread
[Feature] 官方文档几千年没有更新了，对新手非常不友好！
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 12.2k
- Forks
- 5.4k
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 40
Description
Describe problem solved by the proposed feature
新手想要入门学习 RT-Thread，打开 RT-Thread 官方文档并按照文档的说明一步步操作，发现很多地方跟实际根本对不上，节节挫败，越学越想放弃。
Describe your preferred solution
希望每次 RT-Thread 升级后，都相应地更新一下官方文档，例如某些文件的存在路径，某些功能的变化，某些 menuconfig 界面的变化等。
Describe possible alternatives
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue refers broadly to the official RT-Thread documentation, including file paths, feature changes, and menuconfig screens, but names no specific documentation files or tests. Start by comparing the current documentation with the corresponding RT-Thread release; done would require updating the identified mismatches, though the scope is not bounded.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100