改进 env 的文档
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 78
- Forks
- 64
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 7
Description
问题来源参考 https://github.com/RT-Thread/rt-thread/pull/10683
具体的改进思路如下,欢迎补充:
- 将 https://www.rt-thread.org/document/site/#/development-tools/env/env 和 https://rt-thread.github.io/rt-thread/page_env.html 下陈旧的内容和最新代码对齐后补充到这里 https://github.com/RT-Thread/env/ 下, 和 env 的代码统一维护。以后文档中心不再单独维护 env 的文档,需要时直接链接到这里的文档即可。
- 改进时注意统一提供中文版和英文版
- 改进时注意尽量统一 windows 和 linux 下的操作描述(env 工具本身应该是跨平台的,感觉可以统一)。除非有特别的需求再分 windows 和 linux 描述。
Contributor guide
No contributing guide indexed for this repository
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
Start by comparing the existing Chinese and English material at the linked RT-Thread documentation pages with the current RT-Thread/env repository. Consolidate the accurate content in that repository, keeping Windows and Linux instructions unified where possible; done means both language versions are maintained there and the old documentation can link to them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100