优化帮助文档首页介绍

README_zh.md

@@ -17,7 +17,7 @@ NextPilot飞控系统是一款功能丰富、高度扩展、稳定可靠的国
 4. 高效的开发效率。支持 MATLAB/Simulink [基于模型的设计](https://www.mathworks.com/help/simulink/gs/model-based-design.html)，在统一的 Simulink 环境下完成设计、仿真、测试和一键代码生成，快速且经济高效地开发控制系统、信号处理系统和通信系统。
 5. 支持多种飞行仿真，如模型在环（Model in Loop）、软件在环（[Software in Loop](bsps/sitl/qemu/README.md)）、硬件在环（Hardware in Loop）和硬件内飞行仿真（[Simulation in Hardware](apps/simulation/sih/sih.cpp)），以及多机编队仿真。
 
-6. 支持多种飞控硬件，包括广泛使用的开源硬件 [Pixhawk FMUv5](bsps/px4/fmu-v5/README.md) 和 [NextPilot团队开发的硬件](bsps/nt//README.md)。
+6. 支持多种飞控硬件，包括广泛使用的开源硬件 [Pixhawk FMUv5](bsps/px4/fmu-v5/README.md) 和 [NextPilot团队开发的硬件](bsps/ndt//README.md)。
 
 7. 支持主流开发工具，包括 Gcc+VScode（[Windows](https://github.com/nextpilot/nextpilot-windows-toolchain)/[Ubuntu](https://github.com/nextpilot/nextpilot-ubuntu-toolchain)）、Keil 和 IAR等，通过 scons 工具生成多种 IDE 项目文件。
 

docs/develop/01.快速入门/01.setup-develop-environment.md

@@ -24,20 +24,20 @@ git clone --depth=1 https://github.com/nextpilot/nextpilot-windows-toolchain.git
 
 3、在CMD终端里，切换到nextpilot-flight-control/bsps目录，然后运行命令进行配置/编译/仿真：
 
-```bash
-rem 克隆nextpilot飞控项目
+```shell
+# 克隆nextpilot飞控项目
 git clone https://github.com/nextpilot/nextpilot-flight-control.git
 
-rem 切换到bsps目录，比如bsps/sitl/qemu，使用qmeu跑软件在环
+# 切换到bsps目录，比如bsps/sitl/qemu，使用qmeu跑软件在环
 cd nextpilot-flight-control/bsps/sitl/qemu
 
-rem 配置nextpilot项目，仅限开发者
+# 配置nextpilot项目，仅限开发者
 scons --menuconfig
 
-rem 雇佣10个线程编译default目标，更多目标参见config/xxxx.config文件
+# 雇佣10个线程编译default目标，更多目标参见config/xxxx.config文件
 scons default -j10
 
-rem 启用qemu进行虚拟飞行仿真
+# 启用qemu进行虚拟飞行仿真
 qemu.bat
 ```
 

docs/develop/13.代码贡献/README.md

@@ -1,7 +1,9 @@
 # 贡献代码
 
 ## 代码风格
+
 [Visual Stuio Code](https://azure.microsoft.com/zh-cn/products/visual-studio-code/) 默认安装 clang ，另外在工程目录下 `.clang-format` 文件指定了代码格式化风格。在以下操作的时候会自动格式化代码：
+
 - 保存的时候
 - 粘贴的时候
 
@@ -77,33 +79,41 @@ Body 部分是对本次 commit 的详细描述，可以分成多行。
 ### 获取远端信息
 
 首先，需要将远端的分支信息拉取到本地，方法如下：
+
 ```
 git fetch
 ```
+
 ![image-20221021165220086](./image/image-20221021165220086.png)
 
 ### 进行变基操作
 
 将本地分支变基到远端的最新main分支，在变基过程中如果有冲突，需要手动解决：
+
 ```
 git rebase origin/main
 ```
+
 ![image-20221022090648166](./image/image-20221022090648166.png)
 
 ![image-20221022090821858](./image/image-20221022090821858.png)
 
 ### 删除远端分支
 
 由于变基后，本地的开发者分支的时间节点落后于远端分支的时间节点，现在推送本地分支到远端会失败，因此在推送分支前需要删除远端分支。方法如下：
+
 ```
 git push origin --delete <你的分支名称>
 ```
+
 ![image-20221021165903669](./image/image-20221021165903669.png)
 
 ### 同步到远端
 
 变基并删除远端分支之后，就可以将本地分支推动到远端了：
+
 ```
 git push
 ```
-![image-20221021170033561](./image/image-20221021170033561.png)
+
+![image-20221021170033561](./image/image-20221021170033561.png)

docs/develop/13.代码贡献/code-style.md

@@ -0,0 +1 @@
+# 代码风格

docs/develop/README.md

@@ -1,5 +1,34 @@
 # 开发指南
 
+!!! note
+    本节适用于软件开发人员和（新）硬件集成商。如果您只是编译一个现有机架或使用 NextPilot 进行飞行，则不需要它。
 
+本节介绍 如何搭建开发环境、底层框架是什么样的、如何支持新的机型和设备、如何修改飞行控制算法、如何添加新模式、如何集成新硬件以及飞控与外部通信是怎么实现的等。
 
-在开发文档编制过程中，使用了PX4和RT-Thread的相关文档，在此表示感谢。
+- 如何快速入门，比如：[搭建开发环境](./01.快速入门/01.setup-develop-environment.md)、[编译项目代码](01.快速入门/02.build-code.md)、[断点单步调试](./01.快速入门/03.ide-debug.md)等
+
+- 系统框架介绍，比如：[系统启动流程](./03.系统框架/03.system-startup.md)、[FINSH终端](./03.系统框架/05.finsh-console.md)、[ULOG日志](./03.系统框架/07.micro-log.md)等
+
+- 通用模块介绍，比如：[uorb订阅发布机制](./04.通用组件/01.uorb.md)、[param参数管理](./04.通用组件/03.param.md)、[mavlink通信管理](./04.通用组件/05.mavlink.md)等
+
+- 设备驱动介绍，比如：传感器、遥控器、作动器等
+
+- 飞行控制介绍，比如：[机架管理](./06.飞行控制/54.airframe.md)、[飞行模式](./06.飞行控制/59.flight-mode.md)
+
+- 组合导航介绍，比如：
+
+- 飞行仿真介绍，
+
+- 如何调试分析
+
+## 社区支持
+
+问题反馈：<https://github.com/nextpilot/nextpilot-flight-control/issues>
+
+代码提交：<https://github.com/nextpilot/nextpilot-flight-control/pulls>
+
+论坛讨论：<https://github.com/nextpilot/nextpilot-flight-control/discussions>
+
+## 致谢
+
+开发文档中，借用了 [PX4 用户指南](https://gitee.com/rtthread/docs-online) 和 [RT-Thread 在线文档](https://gitee.com/rtthread/docs-online) 等部分资料，在此表示感谢。

docs/index.md

@@ -1,8 +1,20 @@
 
 # Home
 
-NextPilot是一款的高性能高可靠的自动驾驶仪，支持多旋翼、复合翼、固定翼等。软件框架(param/workq)、通信中间层（uorb/mavlink）、控制算法等参考或移植于[PX4 V1.14.2](https://github.com/px4/px4-autopilot.git)项目，并基于国产[RT-Thread V5.0.2](https://github.com/RT-Thread/rt-thread/tree/v5.0.2)实时操作系统进行打造。
+[代码仓库](https://github.com/nextpilot/nextpilot-flight-control) | [开发指南](./develop/README.md) | [用户手册](./manual/README.md)
 
-1. 采用国产[RT-Thread](https://rt-thread.org)实时嵌入式操作系统，拥有高可靠和自主可控等特性；
-1. 支持[MATLAB/Simulink](https://www.mathworks.com)工具链，应用MBD进行飞控算法设计、仿真、验证；
-1. 支持模型在环(MIL)、软件在环(SIL)、硬件在环(HIL)、仿真在环(SIH)等各种飞行验证。
+NextPilot飞控系统是一款功能丰富、高度扩展、稳定可靠的国产先进自动驾驶仪。目标是便捷的应用于教育、研究和工业等领域，让工程师专注于自己的擅长领域（比如嵌入式、控制算法、应用业务）进行高效的开发。
+
+1. 出色的嵌入式性能。基于 [RT-Thread V5.02](https://github.com/RT-Thread/rt-thread/tree/v5.0.2) 国产实时操作系统，它资源占用极低、超低功耗设计、支持高性能应用，拥有活跃的社区、丰富的组件（如FINSH、DFS、ULOG等）、繁荣发展的软件包生态。
+
+2. 丰富的自动驾驶功能。核心算法移植于著名开源飞控软件 [PX4 V1.14.2](https://github.com/PX4/PX4-Autopilot/tree/v1.14.2)，它由来自全世界工业界和学术界的开发者维护，支持多旋翼、复合翼、固定翼、潜水艇等。
+
+3. 高度的可扩展性。拥有良好的软件架构（[uORB](https://github.com/nextpilot/nextpilot-flight-control/pkgs/uORB/uORB.h)、[PARAM](https://github.com/nextpilot/nextpilot-flight-control/pkgs/PARAM/PARAM.h)、[AIRFRAME](https://github.com/nextpilot/nextpilot-flight-control/apps/airframe/README.md)）、代码松耦合（[自动初始化机制](https://www.rt-thread.org/document/site/#/rt-线程版本/rt线程标准/编程手册/basic/basic？id=rt线程-%e8%87%aa%e5%8a%a8%e5%88%9d%e5%a7%8b%e5%8c%96%e6%9c%ba%e5%88%b6)），充分模块化（每个文件夹对应一个独立模块），易于定制和扩展等特性。
+
+4. 高效的开发效率。支持 MATLAB/Simulink [基于模型的设计](https://www.mathworks.com/help/simulink/gs/model-based-design.html)，在统一的 Simulink 环境下完成设计、仿真、测试和一键代码生成，快速且经济高效地开发控制系统、信号处理系统和通信系统。
+
+5. 支持多种飞行仿真，如模型在环（Model in Loop）、软件在环（[Software in Loop](https://github.com/nextpilot/nextpilot-flight-control/bsps/sitl/qemu/README.md)）、硬件在环（Hardware in Loop）和硬件内飞行仿真（[Simulation in Hardware](https://github.com/nextpilot/nextpilot-flight-control/apps/simulation/sih/sih.cpp)），以及多机编队仿真。
+
+6. 支持多种飞控硬件，包括广泛使用的开源硬件 [Pixhawk FMUv5](https://github.com/nextpilot/nextpilot-flight-control/bsps/px4/fmu-v5/README.md) 和 [NextPilot团队开发的硬件](https://github.com/nextpilot/nextpilot-flight-control/bsps/ndt//README.md)。
+
+7. 支持主流开发工具，包括 Gcc+VScode（[Windows](https://github.com/nextpilot/nextpilot-windows-toolchain)/[Ubuntu](https://github.com/nextpilot/nextpilot-ubuntu-toolchain)）、Keil 和 IAR等，通过 scons 工具生成多种 IDE 项目文件。