ros2go: refactor structure and remove unused docs

tianbot · Nov 18, 2024 · 51ee327 · 51ee327
1 parent a810490
commit 51ee327
Show file tree

Hide file tree

Showing 13 changed files with 197 additions and 280 deletions.
diff --git a/docs/.vitepress/config/nav.ts b/docs/.vitepress/config/nav.ts
@@ -3,7 +3,6 @@ import type { DefaultTheme } from "vitepress";
 
 //导航栏
 export const nav: DefaultTheme.Config['nav'] = [
-    { text: '首页', link: '/' },
     { text: '官网', link: 'https://www.tianbot.com' },
     {
         text: 'ROS 产品文档',
@@ -56,10 +55,6 @@ export const nav: DefaultTheme.Config['nav'] = [
     },
     { 
         text: '关于我们',
-        // link: 'https://www.tianbot.com/page?id=4',
-        items: [
-            { text: '联系我们', link: 'contact' },
-            { text: '我们的社群', link: 'community'}
-        ],
+        link: 'about',
     },
 ];
diff --git a/docs/.vitepress/config/sidebar.ts b/docs/.vitepress/config/sidebar.ts
@@ -238,33 +238,36 @@ export const sidebar: DefaultTheme.Config['sidebar'] = {
     '/': [
         {
             //分组标题 1
-            text: '💿 ROS2GO',
-            collapsed: true,
-            link: '/ros2go/guide/',
+            text: 'ROS2GO',
+            collapsed: false,
             items: [
               {
                 text: '使用手册',
                 collapsed: true,
                 link: '/ros2go/guide/',
                 items: [
-                  { text: '如何启动', link: '/ros2go/guide/how-to-start' },
-                  { text: '如何备份', link: '/ros2go/guide/how-to-backup-by-timeshift' },
+                  { text: '如何启动', link: '/ros2go/guide/how-to-start', },
+                  { text: '如何备份', link: '/ros2go/guide/how-to-backup', },
                   { text: '如何恢复', link: '/ros2go/guide/how-to-recover' },
                   { text: '如何升级', link: '/ros2go/guide/how-to-update' },
                 ],
               },
               {
                 text: '设备兼容',
-                link: '/ros2go/applicable/',
+                collapsed: true,
+                link: '/ros2go/applicable',
+                items: [
+                  { text: 'Apple 笔记本(x86)', link: '/ros2go/applicable/macbook' },
+                ],
               },
-              { text: '常见问题', link: '/ros2go/question' },
+              { text: '常见问题', link: '/ros2go/faq' },
               { text: '更新日志', link: '/ros2go/changelog' },
             ],
           },
           {
             //分组标题 2
-            text: '🚚 TOM',
-            collapsed: true,
+            text: 'TOM',
+            collapsed: false,
             link: '/tianbot/',
             items: [
               { text: '注意事项', link: '/tianbot/notice' },
@@ -324,8 +327,8 @@ export const sidebar: DefaultTheme.Config['sidebar'] = {
           },
           {
             //分组标题 3
-            text: '🏁 TIANRACER',
-            collapsed: true,
+            text: 'TIANRACER',
+            collapsed: false,
             link: '/tianracer/',
             items: [
               { text: '注意事项', link: '/tianracer/notice' },
@@ -381,8 +384,8 @@ export const sidebar: DefaultTheme.Config['sidebar'] = {
           },
           {
             //分组标题 3
-            text: '🚀 TIANROVER',
-            collapsed: true,
+            text: 'TIANROVER',
+            collapsed: false,
             link: '/tianrover/',
             items: [
               { text: '注意事项', link: '/tianrover/notice' },
@@ -403,8 +406,8 @@ export const sidebar: DefaultTheme.Config['sidebar'] = {
           },
           {
             //分组标题 4
-            text: '🚗 TIANBOT MINI',
-            collapsed: true,
+            text: 'TIANBOT MINI',
+            collapsed: false,
             link: '/tianbot_mini/',
             items: [
               { text: '注意事项', link: '/tianbot_mini/notice' },
@@ -541,8 +544,8 @@ export const sidebar: DefaultTheme.Config['sidebar'] = {
           },
           {
             //分组标题 5
-            text: '🚁 ROBOMASTER TT',
-            collapsed: true,
+            text: 'ROBOMASTER TT',
+            collapsed: false,
             items: [
               { text: '开箱说明', link: '/rmtt/list' },
               { text: '使用手册', link: '/rmtt/' },
@@ -552,8 +555,8 @@ export const sidebar: DefaultTheme.Config['sidebar'] = {
           },
           {
             //分组标题 6
-            text: '📢 ROSECHO',
-            collapsed: true,
+            text: 'ROSECHO',
+            collapsed: false,
             items: [
               { text: '开箱说明', link: '/rosecho/' },
               { text: '使用手册', link: '/rosecho/guide/' },

diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,57 @@
+# 联系我们
+
+## 销售咨询
+
+E-mail: [email protected]
+
+微信：[WeChat](https://work.weixin.qq.com/kf/kefu/qrcode?kfcode=kfc023b1f66e23716fd)
+
+<div align="left">
+    <img src="https://tianbot-pic.oss-cn-beijing.aliyuncs.com/tianbot-pic/Tianbot-Doc75C1681E802D554A61F2EA32A918D9EF.jpg" width="300" alt="销售咨询二维码" />
+</div>
+
+## 微信公众号
+
+<div align="left">
+    <img src="/wechat_qrcode.png" width="300" alt="微信公众号二维码" />
+</div>
+
+## 微信群
+
+售后专用，方便快捷。
+
+<div align="left">
+    <img src="https://tianbot-pic.oss-cn-beijing.aliyuncs.com/tianbot-pic/Tianbot-Doc75C1681E802D554A61F2EA32A918D9EF.jpg" width="300" alt="微信群二维码" />
+</div>
+
+## QQ 交流群
+
+基于 QQ 的跨平台性（在 Linux 下）长时间的聊天记录存储，成员数量上限的优势，便于资料分享，气氛活跃。
+
+<div align="left">
+    <img src="https://tianbot-pic.oss-cn-beijing.aliyuncs.com/tianbot-pic/Tianbot-DocEE036F120C72CDA9F14B40BB678C2EE9.jpg" width="300" alt="QQ群二维码" />
+</div>
+
+## Bilibili
+
+为大家提供更加直观的视频学习途径。
+
+<div align="left">
+    <img src="https://tianbot-pic.oss-cn-beijing.aliyuncs.com/tianbot-pic/Tianbot-Docimage-20231124165545081.png" width="300" alt="Bilibili二维码" />
+</div>
+
+动动你的金手指，点击链接，关注我们 https://space.bilibili.com/451561151/
+
+<div align="left">
+    <img src="https://tianbot-pic.oss-cn-beijing.aliyuncs.com/tianbot-pic/Tianbot-DocE0367978F9AC6798B840EF2F568D40E8.jpg" width="300" alt="Bilibili关注二维码" />
+</div>
+
+## ROS2GO QQ 频道
+
+便于问题汇总，答疑及知识沉淀、内容分享，方便后来人拾级而上。
+
+点击链接加入 QQ 频道【ROS2GO 交流群】：https://pd.qq.com/s/ff87jqozl
+
+<div align="left">
+    <img src="https://github.com/tianbot/tianbot_docs/assets/150599200/0b95e8c3-e8ef-4abc-8a0e-1f91f261c524" width="300" alt="ROS2GO QQ频道二维码" />
+</div>
diff --git a/docs/community.md b/docs/community.md
diff --git a/docs/contact.md b/docs/contact.md
diff --git a/docs/index.md b/docs/index.md
@@ -20,10 +20,10 @@ hero:
           link: https://space.bilibili.com/451561151
 
 features:
-  - icon: 💿
+  - icon: <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 200"><rect x="40" y="40" width="120" height="120" rx="8" fill="#435B66"/><rect x="50" y="140" width="15" height="10" fill="#FFD700"/><rect x="70" y="140" width="15" height="10" fill="#FFD700"/><rect x="90" y="140" width="15" height="10" fill="#FFD700"/><rect x="110" y="140" width="15" height="10" fill="#FFD700"/><circle cx="140" cy="60" r="5" fill="#4CAF50"/><rect x="40" y="40" width="120" height="40" fill="#ffffff" opacity="0.05"/><text x="100" y="115" font-family="Arial" font-size="48" font-weight="bold" fill="#ffffee" text-anchor="middle">GO!</text></svg>
     title: ROS2GO
     details: 轻松获取完整的 ROS 开发环境体验，秒级启动、随用随走、无需复杂环境配置、不伤宿主 Windows 系统、多维度恢复能力让小白也可无惧折腾...
-    link: /ros2go/
+    link: /ros2go/guide/
   - icon: 🚚
     title: TOM
     details: 自主移动机器人平台系列，主要面向科研教育行业的高性能开源全向移动底盘，提供开源控制程序、开发文档，支持使用 USB、CAN、UART 等作为外部通信接口，可灵活使用打造自己独特的机器人方案...

diff --git a/docs/ros2go/applicable/index.md b/docs/ros2go/applicable/index.md
@@ -1,8 +1,12 @@
 # 设备兼容说明
 
-## 电脑/笔记本
+Linux 系统的硬件兼容性是一个长期存在且十分棘手的问题，通常 Ubuntu 系统的长期支持(LTS)版本硬件驱动会落后最新的 Linux 硬件驱动 1~2 年，然后最新 Linux 硬件驱动又会落后于 Windows 硬件驱动。
 
-> 我们通过直接编译最新的 Linux [主线内核](https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git)，让 ROS2GO 拥有了**兼容市面上绝大多数设备**的能力。
+由于需要同时支持 ROS1、ROS2，我们只能将 Ubuntu 系统钉到远古的 20.04 LTS 版本😭，也就是说如果完全依赖 Ubuntu 系统的硬件驱动，将落后于主流硬件驱动至少五年，这样 ROS2GO 根本无法兼容大部分硬件，尤其是近年来新出的新品。
+
+为了解决这个难题，我们完全放弃了 Ubuntu 官方落后的内核、固件❎，转而通过**魔改内核、直接对接上游固件**的方式✅，使得 ROS2GO 拥有了🔨**兼容市面上绝大多数设备**的能力。但仍然无法做到十全十美，如果您在使用中发现不兼容的设备，请及时通过 QQ 群、频道、微信群等反馈，我们开发人员会第一时间处理。若少数不兼容的设备短时间无法解决，我们也希望您能够理解♥️。
+
+## 内核 {#kernel}
 
 ### 使用指南
 
@@ -29,7 +33,47 @@ journalctl -ek
 
 3. 您也可以到我们的 QQ 频道`晒机`板块，寻找可能与您同配置的机器解决方案
 
-### 早期测试视频
+## 固件 {#firmware}
+
+### 使用指南
+
+> 注：早期版本`v20241019之前`可能有一些过时的包，需要先卸载：`sudo apt purge -y drivers-linux-firmware 2>/dev/null && sudo apt purge -y linux-firmware 2>/dev/null` 
+
+1. 下载固件包`截至2024/11/16`：https://github.com/tianbot/tianbot_docs/releases/download/f20241110/linux-firmware-upstream_20241110-12-ga5b0ee21_all.deb
+2. 安装：`sudo dpkg -i linux-firmware-upstream*.deb`
+3. 重启机器，enjoy！
+
+### 问题反馈
+
+> 如果您在使用中发现不兼容的设备，请及时通过 QQ 群、频道、微信群等反馈，我们开发人员会第一时间处理。
+
+为方便开发人员迅速定位问题，找到解决方案，请您反馈时带上如下命令的返回信息：
+
+```shell
+lspci -k | grep -A 3 -i net
+```
+
+输出示例`不同的硬件会有不同的输出`：
+
+```
+03:00.0 Ethernet controller: Realtek Semiconductor Co., Ltd. RTL8111/8168/8211/8411 PCI Express Gigabit Ethernet Controller (rev 15)
+        DeviceName: Realtek RTL8111E Ethernet LOM
+        Subsystem: Lenovo Device 390b
+        Kernel driver in use: r8169
+        Kernel modules: r8169
+04:00.0 Network controller: Intel Corporation Wi-Fi 6 AX200 (rev 1a)
+        Subsystem: Intel Corporation Device 0080
+        Kernel driver in use: iwlwifi
+        Kernel modules: iwlwifi
+```
+
+## 硬件兼容性 {#hardware}
+
+### 笔记本
+
+一般台式机兼容性都比较好，笔记本则需要注意，以下是早期已经确认支持的部分笔记本型号。新机型的兼容性报告请移步至 QQ 频道`晒机`板块查看。
+
+#### 测试视频
 
 【ROS2GO】ROS随身系统使用教程之笔记本兼容性联想小新Pro13锐龙版2020
 
@@ -66,44 +110,29 @@ journalctl -ek
     style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe>
 </div>
 
+### 网卡
+
+> 一般有线网卡大概率不会有驱动问题。无线网卡则需要注意，以下是部分已经确认支持的无线网卡型号：
+
+- Intel® Wi-Fi 7 BE202
+- Intel® Wi-Fi 7 BE200
+- Intel® Wi-Fi 6E AX411 (Gig+)
+- Intel® Wi-Fi 6E AX211 (Gig+)
+- Intel® Wi-Fi 6E AX210 (Gig+)
+- Intel® Wi-Fi 6 AX203
+- Intel® Wi-Fi 6 AX201
+- Intel® Wi-Fi 6 AX200
+- Intel® Wi-Fi 6 AX101
+- Intel® Wireless-AC 9560
+- Intel® Wireless-AC 9260
+- Qualcomm WCN785x Wi-Fi 7
+- Qualcomm WCN685x Wi-Fi 6
+- Broadcom BCM4356
+- MTK MT792x
+- Realtek RTL8822CE
+- Realtek RTL8825BE
+- ...
 
-## 网卡
-
-> 我们通过直接对接[上游固件](https://gitlab.com/kernel-firmware/linux-firmware)，让 ROS2GO 拥有了**兼容市面上绝大多数网卡**的能力。
-
-### 使用指南
-
-> 注：早期版本`v20241019之前`可能有一些过时的包，需要先卸载：`sudo apt purge linux-firmware drivers-linux-firmware`
-
-1. 下载固件包`截至2024/11/16`：https://github.com/tianbot/tianbot_docs/releases/download/f20241110/linux-firmware-upstream_20241110-12-ga5b0ee21_all.deb
-2. 安装：`sudo dpkg -i linux-firmware-upstream*.deb`
-3. 重启机器，enjoy！
-
-### 问题反馈
-
-> 如果您在使用中发现不兼容的设备，请及时通过 QQ 群、频道、微信群等反馈，我们开发人员会第一时间处理。
-
-为方便开发人员迅速定位问题，找到解决方案，请您反馈时带上如下命令的返回信息：
-
-```shell
-lspci -k | grep -A 3 -i net
-```
-
-输出示例`不同的硬件会有不同的输出`：
-
-```
-03:00.0 Ethernet controller: Realtek Semiconductor Co., Ltd. RTL8111/8168/8211/8411 PCI Express Gigabit Ethernet Controller (rev 15)
-        DeviceName: Realtek RTL8111E Ethernet LOM
-        Subsystem: Lenovo Device 390b
-        Kernel driver in use: r8169
-        Kernel modules: r8169
-04:00.0 Network controller: Intel Corporation Wi-Fi 6 AX200 (rev 1a)
-        Subsystem: Intel Corporation Device 0080
-        Kernel driver in use: iwlwifi
-        Kernel modules: iwlwifi
-```
-
-## 传感器
 
 ### 智能音箱
 
@@ -164,8 +193,6 @@ lspci -k | grep -A 3 -i net
 
 - Intel Realsense系列
 
-........
-
 ### 手柄
 
 - Logitech F710