完善了docs的首页以及导航栏

nextpilot · Aug 16, 2024 · 42b1f99 · 42b1f99
1 parent 47d158b
commit 42b1f99
Show file tree

Hide file tree

Showing 20 changed files with 116 additions and 4 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -0,0 +1,8 @@
+* [首页](index.md)
+* [关于我们](about/)
+* [用户手册](manual/)
+* [开发指南](develop/)
+* [商业定制](solution/)
+* [精彩探索](discovery/)
+* [社区支持](community/)
+* [淘宝店铺](https://nextpilot.taobao.com)
diff --git a/docs/about/events.md b/docs/about/events.md
@@ -0,0 +1 @@
+# 重大事件
diff --git a/docs/about/history.md b/docs/about/history.md
@@ -0,0 +1,7 @@
+# 发展历程
+
+- 2024.3.21，沉静了近 10 年的团队再次复苏，在 github/gitee 上发布了基于 px4 和 rt-thread 的 [NextPilot](https://github.com/nextpilot/nextpilot-flight-control) 飞控项目源代码。
+
+- 2014 ~ 2024，经过 10 年的浪淘沙，有些小伙伴已经发展为 **部长、CTO、副总工、总设计师** 了，但是我们`飞行控制系统`一直饱含着热情。
+
+- 2014.11.1，xx 研究所一群飞控工程师，组建了 NextPilot 飞控项目团队，当时只是一个兴趣爱好组，学习研究 px4 开源飞控。
diff --git a/docs/about/index.md b/docs/about/index.md
@@ -0,0 +1,17 @@
+# 关于我们
+
+NextPilot 致力于为无人机开发者提供一套简单、易用、高效的飞控系统。
+
+- 代码仓库：<https://github.com/nextpilot/nextpilot-flight-control>
+- 开发环境：<https://github.com/nextpilot/nextpilot-windows-toolchain>
+
+## 联系方式
+
+- Email邮箱：<nextpilot@qq.com>
+
+- QQ 交流群：[169075390](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=SVjyrlE5haJd8LM814sbX5s5-uhTolY5&authKey=qqcHVNc6IA3hibOOGBIf2Q9VkQDw01PbHdJ4WLVgxZYU9zcYpcJ42mo2SVY6K3Q4&noverify=0&group_code=169075390)
+
+
+![](../community/scan-add-qq-group.jpg)
+
+
diff --git a/docs/about/roadmap.md b/docs/about/roadmap.md
@@ -0,0 +1,2 @@
+# 技术路线
+
diff --git a/docs/community/contributing.md b/docs/community/contributing.md
@@ -0,0 +1 @@
+# 贡献代码
diff --git a/docs/community/index.md b/docs/community/index.md
@@ -0,0 +1,11 @@
+# 社区支持
+
+交流论坛：<https://github.com/nextpilot/nextpilot-flight-control/discussions>
+
+问题反馈：<https://github.com/nextpilot/nextpilot-flight-control/issues>
+
+提交代码：<https://github.com/nextpilot/nextpilot-flight-control/pulls>
+
+交流QQ群：[169075390](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=SVjyrlE5haJd8LM814sbX5s5-uhTolY5&authKey=qqcHVNc6IA3hibOOGBIf2Q9VkQDw01PbHdJ4WLVgxZYU9zcYpcJ42mo2SVY6K3Q4&noverify=0&group_code=169075390)
+
+![](./scan-add-qq-group.jpg)
diff --git a/docs/community/license.md b/docs/community/license.md
@@ -0,0 +1,34 @@
+# 开源许可
+
+NextPilot follows the [BSD 3-Clause License](https://github.com/nextpilot/nextpilot-flight-control/blob/main/LICENSE). It's completely open-source, can be used in commercial applications for free, does not require the disclosure of code, and has no potential commercial risk.
+
+```
+BSD 3-Clause License
+
+Copyright (c) 2015 - 2024, NextPilot Development Team All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
diff --git a/docs/community/scan-add-qq-group.jpg b/docs/community/scan-add-qq-group.jpg
diff --git a/docs/discovery/index.md b/docs/discovery/index.md
@@ -0,0 +1 @@
+# 精彩探索
diff --git a/docs/discovery/usercase.md b/docs/discovery/usercase.md
@@ -0,0 +1 @@
+# 客户案例
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,7 @@
+mkdocs
 mkdocs-material
 mkdocs-autorefs
 mkdocs-static-i18n
 mkdocstrings
-mkdocs-git-revision-date-localized-plugin
+mkdocs-git-revision-date-localized-plugin
+mkdocs-literate-nav
diff --git a/docs/solution/cfd.md b/docs/solution/cfd.md
@@ -0,0 +1 @@
+# 气动优化设计
diff --git a/docs/solution/index.md b/docs/solution/index.md
@@ -0,0 +1,21 @@
+# 商业定制
+
+[NextPilot](https://github.com/nextpilot) 团队是一家智能无人系统解决方案提供商与服务商，专注于为用户提供无人机总体设计、组合导航、飞行控制、智能应用等领域的产品和方案，拥有多功能科研无人机平台、军工级导航飞控系统、多传感器融合组合导航系统等产品，在高等院校、科研院所、工业部门等众多客户都拥有广泛应用。
+
+## 气动优化设计
+
+- 飞行器气动数据库CFD计算，以及飞行性能分析
+- 飞行器概念设计，气动外形进行快速评估，迭代优化进行初步设计
+
+## 导航飞控开发
+
+- 高性能高可靠性飞行控制系统
+- 基于多传感融合的组合导航系统
+- 快速虚拟飞行仿真/半实物仿真系统
+- PX4、MAVSDK、QGC等定制开发
+
+## 机载智能应用
+
+- 垂起无人机舰载自主起降解决方案
+- 多旋翼/固定翼集群编队控制解决方案
+- 基于机载视觉的环境感知和智能控制
diff --git a/docs/solution/mavlink.png b/docs/solution/mavlink.png
diff --git a/docs/solution/mavsdk.png b/docs/solution/mavsdk.png
diff --git a/docs/solution/px4.png b/docs/solution/px4.png
diff --git a/docs/solution/qgc.md b/docs/solution/qgc.md
@@ -0,0 +1 @@
+# QGC定制开发
diff --git a/docs/solution/qgroundcontrol.png b/docs/solution/qgroundcontrol.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -117,9 +117,10 @@ plugins:
   - search
   - tags
   - autorefs
-  #     - literate-nav:
-  #         nav_file: README.md
-  #         implicit_index: true
+  - literate-nav:
+      nav_file: SUMMARY.md
+      implicit_index: false
+      tab_length: 2
   # - mkdocstrings:
   #     handlers:
   #       python:
@@ -142,6 +143,9 @@ plugins:
   # - git-revision-date-localized:
   #     enable_creation_date: true
 
+not_in_nav: |
+  /**/SUMMARY.md
+
 extra:
   version:
     method: mike