/community-activities

Community Activities in RT-Thread

Create Better English Documentation!

In the spirit of openness, we are maintaining a documentation center for how we create this project and how you can quickly get started using this project. The original RT-Thread documentation was generated in Chinese and has been translated into English by RT-Thread community developers, Non-English speakers. So after the English documents got published, we received some complaints saying that some expressions in this document are not very understandable and have arisen confusion, especially they're new beginners to learn the embedded system.

We're here calling embedded developers to help us perfect the documentation. And hopefully, you will also get to know the embedded system at a much deeper level than you're simply using the technology.

Task List

Status Id docs applicant
opening JOB2022xx xxx Tom(example)
opening JOB202201 https://github.com/RT-Thread/rt-thread/tree/master/documentation/basic/basic.md tushar-wiz & byte-me-stan
opening JOB202202 https://github.com/RT-Thread/rt-thread/tree/master/documentation/env/env.md byte-me-stan
opening JOB202203 https://github.com/RT-Thread/rt-thread/tree/master/documentation/finsh/finsh.md
opening JOB202204 https://github.com/RT-Thread/rt-thread/tree/master/documentation/filesystem/README.md byte-me-stan
opening JOB202205 https://github.com/RT-Thread/rt-thread/tree/master/documentation/interrupt/interrupt.md byte-me-stan
opening JOB202206 https://github.com/RT-Thread/rt-thread/tree/master/documentation/introduction/introduction.md byte-me-stan
opening JOB202207 https://github.com/RT-Thread/rt-thread/tree/master/documentation/kernel-porting/kernel-porting.md
opening JOB202208 https://github.com/RT-Thread/rt-thread/tree/master/documentation/thread-comm/thread-comm.md
opening JOB202209 https://github.com/RT-Thread/rt-thread/tree/master/documentation/thread-sync/thread-sync.md
opening JOB202210 https://github.com/RT-Thread/rt-thread/tree/master/documentation/thread/thread.md
opening JOB202211 https://github.com/RT-Thread/rt-thread/tree/master/documentation/timer/timer.md
opening JOB202212 https://github.com/RT-Thread/rt-thread/tree/master/documentation/device/device.md

How to Contribute?

  1. Submit a PR to apply for a chapter

  2. When PR is approved, you can get started

  3. Review and fix the chapter

    • You can fix grammar, expressions, spellings, marks, or any related

    • You can add a description to elaborate on a certain point

    • You can add examples to show how the code works

    • ...Anything you think can improve this document is all welcome

  4. Pull request

  5. Waiting to be merged.

Every Contribution Counts Tremendously for Open Source Project