update documentation (#5674)

mysterywolf · web-flow · commit 59079fe91fea · 2022-03-14T21:18:14.000+08:00
diff --git a/.gitee/ISSUE_TEMPLATE.zh-TW.md b/.gitee/ISSUE_TEMPLATE.zh-TW.md
diff --git a/.gitee/PULL_REQUEST_TEMPLATE.en.md b/.gitee/PULL_REQUEST_TEMPLATE.en.md
@@ -27,4 +27,4 @@ As part of this pull request, I've considered the following:
 - [ ] All modifications to BSP are justified and do not affect other components or BSPs.
 - [ ] I've commented appropriately where code is tricky.
 - [ ] Code in this PR is of high quality.
-- [ ] This PR complies with [RT-Thread code specification](../documentation/coding_style_en.txt)
+- [ ] This PR complies with [RT-Thread code specification](../documentation/contribution_guide/coding_style_en.txt)
diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md
@@ -27,4 +27,4 @@
 - [ ] 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或
 - [ ] 对难懂代码均提供对应的注释
 - [ ] 本拉取/合并请求代码是高质量的
-- [ ] 本拉取/合并符合[RT-Thread代码规范](../documentation/coding_style_cn.md)
+- [ ] 本拉取/合并符合[RT-Thread代码规范](../documentation/contribution_guide/coding_style_cn.md)
diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-TW.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-TW.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -31,4 +31,4 @@ The following content must not be changed in the submitted PR message. Otherwise
 - [ ] 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
 - [ ] 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
 - [ ] 本拉取/合并请求代码是高质量的 Code in this PR is of high quality
-- [ ] 本拉取/合并使用[formatting](https://github.com/mysterywolf/formatting)等源码格式化工具确保格式符合[RT-Thread代码规范](../documentation/coding_style_cn.md) This PR complies with [RT-Thread code specification](../documentation/coding_style_en.txt) 
+- [ ] 本拉取/合并使用[formatting](https://github.com/mysterywolf/formatting)等源码格式化工具确保格式符合[RT-Thread代码规范](../documentation/contribution_guide/coding_style_cn.md) This PR complies with [RT-Thread code specification](../documentation/contribution_guide/coding_style_en.txt) 
diff --git a/README.md b/README.md
@@ -106,7 +106,7 @@ RT-Thread Studio IDE (a.k.a. RT-Studio) is a one-stop intergrated development en
 
 ## Env Tool
 
-[User Manual](https://www.rt-thread.io/document/site/programming-manual/env/env/) | [Tutorial Videos](https://www.youtube.com/watch?v=dEK94o_YoSo)
+[User Manual](documentation/env/env/) | [Tutorial Videos](https://www.youtube.com/watch?v=dEK94o_YoSo)
 
 In the early stage, RT-Thread team also created an auxiliary tool called Env. It is an auxiliary tool with a TUI (Text-based user interface). Developers can use Env tool to configure and generate the GCC, Keil MDK, and IAR projects.
 
@@ -122,9 +122,9 @@ Based on [STM32F103 BluePill](https://github.com/RT-Thread/rt-thread/tree/master
 
 RT-Thread BSP can be compiled directly and downloaded to the corresponding development board for use. In addition, RT-Thread also provides qemu-vexpress-a9 BSP, which can be used without hardware platform. See the getting started guide below for details.
 
-- [Getting Started of QEMU with Env(Windows)](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/documentation/quick_start_qemu/quick_start_qemu.md)
+- [Getting Started of QEMU with Env(Windows)](documentation/quick-start/quick_start_qemu/quick_start_qemu.md)
 
-- [Getting Started of QEMU with Env(Ubuntu)](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/documentation/quick_start_qemu/quick_start_qemu_linux.md)
+- [Getting Started of QEMU with Env(Ubuntu)](documentation/quick-start/quick_start_qemu/quick_start_qemu_linux.md)
 
 # License
 
@@ -146,5 +146,5 @@ RT-Thread is very grateful for the support from all community developers, and if
 
 # Contribution
 
-If you are interested in RT-Thread and want to join in the development of RT-Thread and become a code contributor,please refer to the [Code Contribution Guide](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/documentation/contribution_guide/contribution_guide.md).
+If you are interested in RT-Thread and want to join in the development of RT-Thread and become a code contributor,please refer to the [Code Contribution Guide](documentation/contribution_guide/contribution_guide.md).
 
diff --git a/README_zh.md b/README_zh.md
@@ -58,7 +58,7 @@ Env 是RT-Thread推出的开发辅助工具，针对基于RT-Thread操作系统
 
 [下载 Env 工具](https://www.rt-thread.org/page/download.html)
 
-[Env 用户手册](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md)
+[Env 用户手册](https://www.rt-thread.org/document/site/#/development-tools/env/env)
 
 
 # 资源文档
@@ -110,9 +110,9 @@ RT-Thread Studio演示：
 
 RT-Thread BSP可以直接编译并下载到相应的开发板使用。此外，RT-Thread还提供 qemu-vexpress-a9 BSP，无需硬件平台即可使用。有关详细信息，请参阅下面的入门指南。
 
-[QEMU 入门指南(Windows)](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/documentation/quick_start_qemu/quick_start_qemu.md)
+[QEMU 入门指南(Windows)](documentation/quick-start/quick_start_qemu/quick_start_qemu.md)
 
-[QEMU 入门指南(Ubuntu)](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/documentation/quick_start_qemu/quick_start_qemu_linux.md)
+[QEMU 入门指南(Ubuntu)](documentation/quick-start/quick_start_qemu/quick_start_qemu_linux.md)
 
 
 ## 文档
@@ -149,7 +149,7 @@ RT-Thread系统完全开源，3.1.0 及以前的版本遵循 GPL V2 + 开源许
 
 # 社区支持
 
-RT-Thread非常感谢所有社区小伙伴的支持，在使用RT-Thread的过程中若您有任何的想法，建议或疑问都可通过以下方式联系到 RT-Thread，我们也实时在这些频道更新RT-Thread的最新讯息。同时，任何问题都可以在 [issue section](https://github.com/RT-Thread/rtthread-manual-doc/issues) 中提出。通过创建一个issue来描述您的问题，社区成员将回答这些问题。
+RT-Thread非常感谢所有社区小伙伴的支持，在使用RT-Thread的过程中若您有任何的想法，建议或疑问都可通过以下方式联系到 RT-Thread，我们也实时在这些频道更新RT-Thread的最新讯息。同时，任何问题都可以在 [论坛](https://club.rt-thread.org/index.html) 中提出，社区成员将回答这些问题。
 
 [官网]( https://www.rt-thread.org) | [论坛]( https://www.rt-thread.org/qa/forum.php) | [哔哩哔哩官方账号](https://space.bilibili.com/423462075?spm_id_from=333.788.b_765f7570696e666f.2) | [微博官方账号](https://weibo.com/rtthread?is_hot=1) | [知乎官方账号](https://www.zhihu.com/topic/19964581/hot)
 
@@ -160,5 +160,5 @@ RT-Thread微信公众号：
 
 # 贡献代码
 
-如果您对RT-Thread感兴趣，并希望参与RT-Thread的开发并成为代码贡献者，请参阅[代码贡献指南](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/documentation/contribution_guide/contribution_guide.md)。
+如果您对RT-Thread感兴趣，并希望参与RT-Thread的开发并成为代码贡献者，请参阅[代码贡献指南](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/development-guide/github/githubd)。
 
diff --git a/bsp/imxrt/imxrt1052-nxp-evk/README.md b/bsp/imxrt/imxrt1052-nxp-evk/README.md
@@ -77,4 +77,4 @@ This BSP only enables GPIO and serial port 1 by default. If you need more advanc
 3. Enter pkgs --update command to update the package;
 4. Enter scons --target=mdk4/mdk5/iar command to regenerate the project.
 
-Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md).
+Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md).
diff --git a/bsp/raspberry-pi/raspi3-64/README.md b/bsp/raspberry-pi/raspi3-64/README.md
@@ -10,7 +10,7 @@ This document records the execution instruction of the BSP (board support packag
 
 ### Build Environment on Windows
 
-It's recommended to use the [env tool ](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md)to compile the Raspberry PI 3–64 BSP on Windows. Firstly, download the compiler GCC on Windows, from the official ARM website. You can refer to [Here](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-a/downloads).
+It's recommended to use the [env tool ](https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md)to compile the Raspberry PI 3–64 BSP on Windows. Firstly, download the compiler GCC on Windows, from the official ARM website. You can refer to [Here](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-a/downloads).
 
 Here we choose the version "[gcc-arm-8.3–2019.03-i686-mingw32-aarch64-elf]. 
 
diff --git a/bsp/raspberry-pico/applications/lvgl/README.md b/bsp/raspberry-pico/applications/lvgl/README.md
@@ -1,4 +1,4 @@
-# Get Raspberry Pi PICO Running on RT-Thread RTOS with an Opensource Light Versatile Graphics Library
+# How to Run LVGL on Raspberry Pi PICO
 
 [中文页](README_zh.md) |
 
diff --git a/bsp/raspberry-pico/applications/lvgl/README_zh.md b/bsp/raspberry-pico/applications/lvgl/README_zh.md
@@ -1,4 +1,4 @@
-# Raspberry_pico 使用 RT-Thread 运行 lvgl
+# Raspberry Pi PICO 运行 LVGL 指南
 
 ## 硬件参数
 
diff --git a/bsp/stm32/docs/STM32_Nucleo-144_BSP_Introduction.md b/bsp/stm32/docs/STM32_Nucleo-144_BSP_Introduction.md
@@ -109,7 +109,7 @@ This BSP only enables GPIO and USART3 by default. If you need more advanced feat
 3. Enter `pkgs --update` command to update the package;
 4. Enter `scons --target=mdk4/mdk5/iar` command to regenerate the project.
 
-Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md).
+Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md).
 
 
 
diff --git a/bsp/stm32/docs/STM32_Nucleo-64_BSP_Introduction.md b/bsp/stm32/docs/STM32_Nucleo-64_BSP_Introduction.md
@@ -107,7 +107,7 @@ This BSP only enables GPIO and USART2 by default. If you need more advanced feat
 3. Enter `pkgs --update` command to update the package;
 4. Enter `scons --target=mdk4/mdk5/iar` command to regenerate the project.
 
-Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md).
+Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md).
 
 
 
diff --git a/bsp/stm32/stm32f091-st-nucleo/README.md b/bsp/stm32/stm32f091-st-nucleo/README.md
@@ -93,5 +93,5 @@ This BSP only enables GPIO and serial port 2 by default. If you need more advanc
 3. Enter pkgs --update command to update the package;
 4. Enter scons --target=mdk4/mdk5/iar command to regenerate the project.
 
-Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md).
+Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md).
 
diff --git a/bsp/stm32/stm32f103-blue-pill/README.md b/bsp/stm32/stm32f103-blue-pill/README.md
@@ -251,7 +251,7 @@ This BSP only enables GPIO and USART1 by default. If you need more advanced feat
 3. Enter `pkgs --update` command to update the package;
 4. Enter `scons --target=mdk4/mdk5/iar` command to regenerate the project.
 
-Learn how to use RT-Thread ENV, click [Here](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md).
+Learn how to use RT-Thread ENV, click [Here](https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md).
 
 
 
diff --git a/bsp/stm32/stm32h747-st-discovery/README.md b/bsp/stm32/stm32h747-st-discovery/README.md
@@ -82,7 +82,7 @@ This BSP only enables GPIO and serial port 1 by default. If you need more advanc
 3. Enter pkgs --update command to update the package.
 4. Enter scons --target=mdk4/mdk5/iar command to regenerate the project.
 
-Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rtthread-manual-doc/blob/master/env/env.md).
+Learn how to use RT-Thread Env, click [Here](https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md).
 
 ## **Notes**
 
diff --git a/documentation/README.md b/documentation/README.md
@@ -1,90 +1,3 @@
-# RT-Thread
-
-RT-Thread (Real-Time Thread) is an open source embedded real-time operating system and released under Apache License v2.0. It has a strong scalability: from a nano kernel running on a tiny MCU, for example ARM Cortex-M0, or Cortex-M3/4/7, to a rich feature system running on MIPS32, ARM Cortex-A, even the emerging open source RISC-V architecture is supported. RT-Thread can run either on single-core systems or on symmetric multi-core processors(SMP) systems.
-
-## Introduction
-
-RT-Thread has not noly a real-time kernel, but also rich components. Its architecture is as follows:
-
-![RT-Thread system framework](figures/02Software_framework_diagram.png)
-
-- **Kernel**: It includes preemptive multi-task real-time scheduler, and infrastructure such as semaphore, mutex, mailbox, message queue, signal, event, memory management, timer management, interrupt management, etc. It also includes libcpu/BSP (file related to chip transplantation/board support package).
-- **components**: It is a software unit on the RT-Thread kernel layer, such as command line (FinSH), device driver framework (Device Drivers), network framework, virtual file system (FAT, YAFFS, UFFS, ROM/RAM file system, etc.), TCP/IP network protocol stack (lwIP), libc/POSIX standard layer and so on. Generally, a software component is placed in a folder in the RT-Thread/components directory, and each software component is described by a *SConscript* file and added to the RT-Thread construction system. When a software component is opened in the system configuration, it will be compiled and linked to the final RT-Thread firmware.
-- **Packages**: It is a middleware running on RT-Thread IoT operating system platform and facing different application fields. Packages consist of description information, source code or library files. These packages can be provided by RT-Thread, third-party developers and enterprises, and the license agreement of the packages is provided by the author of the packages. These software packages have strong reusability and high modularity, which greatly facilitates application developers to build their desired application systems in the shortest time. For more package information, visit the [RT-Thread package repository](https://github.com/RT-Thread-packages).
-
-## Licence
-
-RT-Thread  is an open source software and has been licensed under Apache License Version 2.0 since v3.1.1. License information and copyright information can generally be seen at the beginning of the code:
-
-```
-/*
- * Copyright (c) 2006-2018, RT-Thread Development Team
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-```
-
-To avoid possible future license conflicts, developers need to sign a Contributor License Agreement (CLA) when submitting PR to RT-Thread.
-
-> Note: Because the BSP also contains the code provided by the chip manufacturer, this part of the code follows the license provided by the chip manufacturer, such as STM32 HAL, NXP, Atmel, etc. Relevant codes are usually only used in the chips of the corresponding manufacturers.
-
-## Supported Architectures
-
-RT-Thread RTOS can support many architectures,and has covered the major architectures in current applications. Architecture and chip manufacturer involved:
-
-- **ARM Cortex-M0/M0+**：manufacturers like ST
-- **ARM Cortex-M3**：manufacturers like ST、Winner Micro、MindMotion, ect.
-- **ARM Cortex-M4**：manufacturers like ST、Nuvton、NXP、GigaDevice、Realtek、Ambiq Micro, ect.
-- **ARM Cortex-M7**：manufacturers like ST、NXP
-- **ARM Cortex-M23**：manufacturers like GigaDevice
-- **ARM Cortex-R4**
-- **ARM Cortex-A8/A9**：manufacturers like NXP
-- **ARM7**：manufacturers like Samsung
-- **ARM9**：manufacturers like Allwinner、Xilinx 、GOKE
-- **ARM11**：manufacturers like Fullhan
-- **MIPS32**：manufacturers like loongson、Ingenic
-- **RISC-V**：manufacturers like Hifive、Kendryte
-- **ARC**：manufacturers like SYNOPSYS
-- **DSP**：manufacturers like TI
-- **C-Sky**
-- **x86**
-
-## Supported IDE and Compiler
-
-The main IDE/compilers supported by RT-Thread are:
-
-- MDK KEIL
-- IAR
-- GCC
-
-Use Python-based [scons](http://www.scons.org) for command-line builds.
-
-# Source Code and Tools
-
-**Get the source code**: The source code of RT-Thread is hosted on Github, and click on the link to get the source code.
-
-- [Download RT-Thread source code](https://github.com/RT-Thread/rt-thread)
-
-**Get the Env Tool**: To better help developers, the RT-Thread team also provides Env tools (or Env scripts for Linux/MacOS). On Windows, Env tool is a development assistant tool launched by RT-Thread. It provides compiling and building environment, graphical system configuration and software package management functions for project projects based on RT-Thread operating system. Its built-in menuconfig provides a simple and easy-to-use configuration tailoring tool, which can tailor the kernel, components and software packages freely, so that the system can be built in the way of building blocks.
-
-- [Download Env Tool]()
-- [User manual of Env](env/env.md)
-
-# Getting Started
-
-RT-Thread BSP can be compiled directly and downloaded to the corresponding development board for use. In addition, RT-Thread also provides qemu-vexpress-a9 BSP, which can be used without hardware platform. See the getting started guide below for details.
-
-- [Getting Started of QEMU (Windows)](quick-start/quick_start_qemu/quick_start_qemu.md)
-- [Getting Started of QEMU (Ubuntu)](quick-start/quick_start_qemu/quick_start_qemu_linux.md)
-
-# Help
-
-Any questions can be asked in the [issue section of rtthread-manual-doc](https://github.com/RT-Thread/rtthread-manual-doc/issues). By creating a new issue to describe your questions, community members will answer them.
-
-# Contribution
-
-If you are interested in RT-Thread and want to join in the development of RT-Thread and become a code contributor,please refer to the [Code Contribution Guide](documentation/contribution_guide/contribution_guide.md).
-
 # Manual Catalogue
 
 - [RT-Thread Introduction](introduction/introduction.md)
diff --git a/documentation/figures/02Software_framework_diagram.png b/documentation/figures/02Software_framework_diagram.png

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Get Raspberry Pi PICO Running on RT-Thread RTOS with an Opensource Light Versatile Graphics Library`
	`1`	`+# How to Run LVGL on Raspberry Pi PICO`
`2`	`2`
`3`	`3`	`[中文页](README_zh.md) \|`
`4`	`4`