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

Open
#11,230 5 comments 7 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Quiet
Domain
documentation

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.

Description

Describe problem solved by the proposed feature

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

Describe your preferred solution

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

Describe possible alternatives

No response

Dominant language
C
Stars
12.4k
Forks
5.5k
Avg merge
3d 7h
Merged PRs (30d)
79

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from RT-Thread/rt-thread

All issues in RT-Thread/rt-thread

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.