update doc

README.md

@@ -32,7 +32,7 @@ English | [中文](./README_ZH.md)
 > New MaixPy (v4) and new hardware platform MaixCAM is coming now(2024.4)!<br>
 > If you have any suggestions, tell us on [MaixHub](https://maixhub.com/discussion/100073), or [Telegram/MaixPy](https://t.me/maixpy) or QQ group: 862340358.
 >
-> Click the **Star** in the upper right corner to let us know you like it then more features will be added.
+> Click the **Star** in the upper right corner to let us know you like it to encourage us to add more features.
 
 
 ## Introduction
@@ -57,7 +57,7 @@ while 1:
 
 Result video:
 
-<video controls autoplay loop muted preload src="https://wiki.sipeed.com/maixpy/static/video/classifier.mp4" type="video/mp4">
+<video controls autoplay loop muted preload src="https://github.com/sipeed/MaixPy/assets/8625829/d06e4f0e-31af-4679-b3bc-1f93cd633af0" type="video/mp4">
 Classifier Result video
 </video>
 
@@ -144,7 +144,7 @@ Here's the comparison between them:
 | Camera | 30W | 200W | **500W** |
 | WiFi   | 2.4G | 2.4G | **WiFi6** 2.4G/5G |
 | USB    | ✖    | **USB2.0** | **USB2.0** |
-| Eth    | ✖    | 100M   | 100M |
+| Eth    | ✖    | 100M(Optional)   | 100M(Optional) |
 | SD Interface | SPI | **SDIO** | **SDIO** |
 | BLE    | ✖    | ✖      | **BLE5.4** |
 | OS     | RTOS | Tina Linux | **Linux + RTOS** |

README_ZH.md

@@ -57,7 +57,7 @@ while 1:
 
 效果视频:
 
-<video controls autoplay loop muted preload src="https://wiki.sipeed.com/maixpy/static/video/classifier.mp4" type="video/mp4">
+<video controls autoplay loop muted preload src="https://github.com/sipeed/MaixPy/assets/8625829/d06e4f0e-31af-4679-b3bc-1f93cd633af0" type="video/mp4">
 Classifier Result video
 </video>
 

docs/config/config_en.json

@@ -6,34 +6,157 @@
             "alt": "MaixPy logo",
             "url": ""
         },
-        "home_url": "/",
+        "home_url": "/en/",
         "items": [
             {
-                "url": "/api/",
-                "label": "API Doc",
+                "url": "https://wiki.sipeed.com",
+                "label": "Sipeed Wiki",
                 "position": "left"
+            },
+            {
+                "url": "/doc/en/index.html",
+                "label": "Documentation",
+                "position": "left"
+            },
+            {
+                "url": "/api/index.html",
+                "label": "API",
+                "position": "left"
+            },
+            {
+                "url": "/doc/en/faq.html",
+                "label": "FAQ",
+                "position": "left"
+            },
+            {
+                "id": "github",
+                "label": "<img src='/maixpy/static/image/github-fill.svg' style='height: 1.5em;vertical-align: middle;'>&nbsp;",
+                "url": "https://github.com/sipeed/maixpy",
+                "position": "right",
+                "target": "_blank"
+            },
+            {
+                "id": "language",
+                "label": "<img src='/maixpy/static/image/language.svg' style='height: 1.5em;vertical-align: middle;'>&nbsp;",
+                "position": "right",
+                "type": "language"
             }
         ]
     },
     "footer":{
         "top":[
             {
-                "label": "",
+                "label": "Links",
                 "items": [
                     {
-                        "label": "",
-                        "url": "#",
+                        "label": "Sipeed Wiki",
+                        "url": "https://wiki.sipeed.com",
+                        "target": "_blank"
+                    },
+                    {
+                        "label": "Sipeed Official",
+                        "url": "https://www.sipeed.com",
+                        "target": "_blank"
+                    },
+                    {
+                        "label": "MaixHub",
+                        "url": "https://maixhub.com/",
+                        "target": "_blank"
+                    },
+                    {
+                        "label": "Site map",
+                        "url": "/sitemap.xml"
+                    },
+                    {
+                        "label": "Generated by teedoc",
+                        "url": "https://github.com/neutree/teedoc",
                         "target": "_blank"
                     }
                 ]
+            },
+            {
+                "label": "Source code",
+                "items": [
+                    {
+                        "label": "MaixPy source code",
+                        "url": "https://github.com/sipeed/maixpy",
+                        "target": "_blank"
+                    },
+                    {
+                        "label": "MaixCDK source code",
+                        "url": "https://github.com/sipeed/MaixCDK",
+                        "target": "_blank"
+                    },
+                    {
+                        "label": "Wiki source code",
+                        "url": "https://github.com/sipeed/sipeed_wiki",
+                        "target": "_blank"
+                    },
+                    {
+                        "label": "Open source projects",
+                        "url": "https://github.com/sipeed",
+                        "target": "_blank"
+                    }
+                ]
+            },
+            {
+                "label": "Follow us",
+                "items": [
+                    {
+                        "label": "twitter",
+                        "url": "https://twitter.com/SipeedIO",
+                        "target":"_blank"
+                    },
+                    {
+                        "label": "Taobao",
+                        "url": "https://sipeed.taobao.com/",
+                        "target":"_blank"
+                    },
+                    {
+                        "label": "AliExpress",
+                        "url": "https://www.aliexpress.com/store/911876460",
+                        "target":"_blank"
+                    },
+                    {
+                        "label": "github",
+                        "url": "https://github.com/sipeed",
+                        "target":"_blank"
+                    },
+                    {
+                        "label": "<a>Wechat </a><img src='/maixpy/static/image/wechat.png'>"
+                    }
+                ]
+            },
+            {
+                "label": "Contact us",
+                "items": [
+                    {
+                        "label": "Tel: +86 0755-27808509"
+                    },
+                    {
+                        "label": "Bussiness: support@sipeed.com"
+                    },
+                    {
+                        "label": "Addr: 深圳市宝安区新湖路4008号蘅芳科技办公大厦A座-2101C"
+                    },
+                    {
+                        "label": "Join us",
+                        "url": "https://wiki.sipeed.com/join_us.html"
+                    }
+                ]
             }
         ],
         "bottom": [
             {
-                "label": "Generated by teedoc",
-                "url": "https://github.com/teedoc/teedoc",
+                "label": "©2018-2023 深圳矽速科技有限公司",
+                "url": "https://www.sipeed.com",
+                "target": "_blank"
+            },
+            {
+                "label": "粤ICP备19015433号",
+                "url": "https://beian.miit.gov.cn/#/Integrated/index",
                 "target": "_blank"
             }
         ]
     }
-}
+}

docs/config/config_zh.json

@@ -28,6 +28,13 @@
                 "label": "FAQ",
                 "position": "left"
             },
+            {
+                "id": "github",
+                "label": "<img src='/maixpy/static/image/github-fill.svg' style='height: 1.5em;vertical-align: middle;'>&nbsp;",
+                "url": "https://github.com/sipeed/maixpy",
+                "position": "right",
+                "target": "_blank"
+            },
             {
                 "id": "language",
                 "label": "<img src='/maixpy/static/image/language.svg' style='height: 1.5em;vertical-align: middle;'>&nbsp;",
@@ -105,6 +112,11 @@
                         "url": "https://sipeed.taobao.com/",
                         "target":"_blank"
                     },
+                    {
+                        "label": "AliExpress",
+                        "url": "https://www.aliexpress.com/store/911876460",
+                        "target":"_blank"
+                    },
                     {
                         "label": "github",
                         "url": "https://github.com/sipeed",
@@ -147,4 +159,4 @@
             }
         ]
     }
-}
+}

docs/doc/zh/README.md

@@ -15,21 +15,23 @@ title: MaixPy 快速开始
 </div>
 <br>
 
-> 关于 MaixPy 介绍请看 [MaixPy 官网首页](../../README.md)
+> 关于 MaixPy 介绍请看 [MaixPy 官网首页](../README.md)
 
 ## 获得 MaixCAM 设备
 
-在 [Sipeed 淘宝](https://sipeed.taobao.com) 或者 [Sipeed 速卖通](https://sipeed.aliexpress.com) 店铺购买 `MaixCAM` 开发板。
+在 [Sipeed 淘宝](https://sipeed.taobao.com) 或者 [Sipeed 速卖通](https://sipeed.aliexpress.com) 店铺购买 <a href="https://wiki.sipeed.com/maixcam" target="_blank">MaixCAM</a> 开发板。
 
 **建议购买带 `TF 卡`、`摄像头`、`2.3寸触摸屏`、`外壳`、`Type-C一转二小板`、`4P串口座子+线`的套餐**，方便后续使用和开发，**后面的教程都默认你已经有了这些配件**（包括屏幕）。
 
 另外需要准备一根 `Type-C` 数据线，尽量买质量好点的防止供电和连接不稳定。
 
+>! 注意，目前只支持 MaixCAM 开发板，其它同型号芯片的开发板均不支持，包括 Sipeed 的同型号芯片开发板，请注意不要买错造成不必要的时间和金钱浪费。
+
 
 ## 上手体验
 
-插入套餐里面的 TF 卡，使用 `Type-C` 数据线连接 `MaixCAM` 设备给设备供电，等待设备开机，开机会显示 `MaixCAM` LOGO，然后进入功能选择界面。
-> 如果屏幕没有显示，请咨询卖家。
+插入套餐里面的 TF 卡，使用 `Type-C` 数据线连接 `MaixCAM` 设备给设备供电，等待设备开机，开机会进入功能选择界面。
+> 如果屏幕没有显示，请确认购买了配套的 TF 卡，如果确认有 TF 卡，可以尝试[更新系统](./basic/os.md)。
 > 如果你没有购买 TF 卡套餐，你需要按照[升级和烧录系统](./basic/os.md)的方法烧录最新的系统到 TF 卡。
 
 开机后可以看到功能选择界面，在设置中可以切换语言，可以自行尝试内置的各种应用和功能。
@@ -42,16 +44,36 @@ title: MaixPy 快速开始
 使用方法：
 * 硬件连接： 可以给设备接上`Type-C一转二小板`，这样我们就能将设备通过串口连接到你的主控上了，比如`Arduino`、`树莓派`、`STM32`等等。
 * 打开你想用的应用，比如二维码识别，当设备扫描到二维码就会通过串口把结果发送给你的主控了。
-> 发送的串口波特率是 `115200`，数据格式是 `8N1`，协议遵循 [Maix 串口通信协议标准](https://wiki.sipeed.com/maixcdk/doc/convention/protoco.md)，可以在[MaixHub APP](https://maixhub.com/app) 找到对应的应用介绍查看协议。
-
+> 发送的串口波特率是 `115200`，数据格式是 `8N1`，协议遵循 [Maix 串口通信协议标准](https://wiki.sipeed.com/maixcdk/docs/doc/convention/protoco.md)，可以在[MaixHub APP](https://maixhub.com/app) 找到对应的应用介绍查看协议。
+
+## 准备连接电脑和设备
+
+为了后面电脑（PC）能和 设备（MaixCAM）通信，我们要让它们在同一个局域网内，提供了两种方式：
+* **方法一**：无线连接， 设备使用 WiFi 连接到电脑连接的同一个路由器或者 WiFi 热点下： 在设备的`设置 -> WiFi 设置`中连接到你的 WiFi 即可。
+* **方法二**：有线连接， 设备通过 USB 线连接到电脑，设备会虚拟成一个 USB 网卡，这样和电脑就通过 USB 在同一局域网了。
+
+方案二在不同电脑系统中有不同设置方法：
+* **Linux**: 无需额外设置，插上 USB 线即可， 使用 `ifconfig` 或者 `ip addr` 查看到 `usb0` 网卡
+* **Windows**: 可以先确认`网络适配器`里面是否多了一个 RNDIS 设备，如果有就直接能用。否则需要手动安装 RNDIS 网卡驱动：
+  * 打开电脑的`设备管理器`。
+  * 然后在`其它设备`里面找个一个带问号的 RNDIS 设备，右键选择`更新驱动程序`。
+  * 选择`浏览计算机以查找驱动程序`，然后选择`让我从计算机上的可用驱动程序列表中选择`。
+  * 选择`网络适配器`，然后点击`下一步`。
+  * 左边选择`Microsoft`，右边选择`远程 NDIS 兼容设备`，然后点击`下一步`, 选择`是`。
+  * 装好后的效果
+  ![RNDIS](../../static/image/rndis_windows.jpg)
+* **MacOS**: 无需额外设置，插上 USB 线即可， 使用 `ifconfig` 或者 `ip addr` 查看到 `usb0` 网卡
 
 ## 开发环境准备
 
-* 下载 [MaixVision](https://wiki.sipeed.com/maixvision) 并安装。 Linux 下推荐安装 deb 包。
+* 下载 [MaixVision](https://wiki.sipeed.com/maixvision) 并安装。
 * 使用 Type-C 连接设备和电脑，打开 MaixVision，点击左下角的`“连接”`按钮，会自动搜索设备，稍等一下就能看到设备，点击设备有点的连接按钮以连接设备。
-> 如果找不到设备，请在[FAQ](./faq.md)中查找解决方法。
-> 如果 USB 驱动确实没法安装，可以在设备设置里面连接和电脑同一局域网的 WiFi 即可。
 
+如果没有扫描到设备，你也可以在设备的 `设置 -> 设备信息` 中查看设备的 IP 地址手动输入。
+
+这里有 MaixVision 的使用示例视频:
+
+<video style="width:100%" controls muted preload src="/static/video/maixvision.mp4"></video>
 
 ## 运行例程
 
@@ -65,37 +87,43 @@ from maix import camera, display, app
 
 disp = display.Display()          # 构造一个显示对象，并初始化屏幕
 cam = camera.Camera(640, 480)     # 构造一个摄像头对象，手动设置了分辨率为 640x480, 并初始化摄像头
-while not app.need_exit():        # 一直循环，直到程序退出（可以通过按下设备上方的按键退出或者 MaixVision 点击停止按钮退出）
+while not app.need_exit():        # 一直循环，直到程序退出（可以通过按下设备的功能按键退出或者 MaixVision 点击停止按钮退出）
     img = cam.read()              # 读取摄像头画面保存到 img 变量，可以通过 print(img) 来打印 img 的详情
     disp.show(img)                # 将 img 显示到屏幕上
 ```
-* `yolov5.py` 会检测摄像头画面中的物体框出来并显示到屏幕上，支持 80 种物体的检测。
+* `yolov5.py` 会检测摄像头画面中的物体框出来并显示到屏幕上，支持 80 种物体的检测，具体请看[YOLOv5 物体检测](./vision/yolov5.md)。
 
 其它例程可以自行尝试。
 
 ## 安装应用到设备
 
-点击 MaixVision 左下侧的安装应用按钮，填写应用信息，会将应用安装到设备上，然后在设备上就能看到应用了。
+上面是在设备中运行代码，`MaixVision` 断开后代码就会停止运行，如果想让代码出现在开机菜单中，可以打包成应用安装到设备上。
+
+点击 `MaixVision` 左下侧的安装应用按钮，填写应用信息，会将应用安装到设备上，然后在设备上就能看到应用了。
 也可以选择打包应用，将你的应用分享到[MaixHub 应用商店](https://maixhub.com/app)。
 
-> 默认例程没有显式编写退出功能，进入应用后按下设备上方的按键即可退出应用。
+> 默认例程没有显式编写退出功能，进入应用后按下设备的功能按键即可退出应用。（对于 MaixCAM 是 user 键）
+
+如果想让程序开机自启动，可以在 `设置 -> 开机启动` 中设置。
 
 
 ## 下一步
 
-看到这里，如果你觉得不错，**请务必来 [github](https://github.com/sipeed/MaixPy) 给 MaixPy 开源项目点一个 star（需要先登录 github）, 你的 star 和认同是我们不断维护和完善的动力！**
+看到这里，如果你觉得不错，**请务必来 [github](https://github.com/sipeed/MaixPy) 给 MaixPy 开源项目点一个 star（需要先登录 github）, 你的 star 和认同是我们不断维护和添加新功能的动力！**
 
 到这里你已经体验了一遍使用和开发流程了，接下来可以学习 `MaixPy` 语法和功能相关的内容，请按照左边的目录进行学习，如果遇到 `API` 使用问题，可以在[API 文档](/api/)中查找。
 
 学习前最好带着自己学习的目的学，比如做一个有趣的小项目，这样学习效果会更好，项目和经验都可以分享到[MaixHub 分享广场](https://maixhub.com/share)，会获得现金奖励哦！
 
 ## 分享交流
 
-* [MaixHub 项目和经验分享](https://maixhub.com/share) ：分享你的项目和经验，获得现金打赏，获得官方打赏的基本要求：
-  * 可复现型：较为完整的项目制作复现过程。
-  * 炫耀型：无详细的项目复现过程，但是项目展示效果吸引人。
+* **[MaixHub 项目和经验分享](https://maixhub.com/share)** ：分享你的项目和经验，获得现金打赏，获得官方打赏的基本要求：
+  * **可复现型**：较为完整的项目制作复现过程。
+  * **炫耀型**：无详细的项目复现过程，但是项目展示效果吸引人。
   * Bug 解决经验型：解决了某个难题的过程和具体解决方法分享。
 * [MaixPy 官方论坛](https://maixhub.com/discussion/maixpy)（提问和交流）
 * QQ 群： （建议在 QQ 群提问前先发个帖，方便群友快速了解你需要了什么问题，复现过程是怎样的）
   * MaixPy (v4) AI 视觉交流大群: 862340358
-* Telegram: [MaixPy](https://t.me/maixpy)
+* Telegram: [MaixPy](https://t.me/maixpy)。
+* 商业合作或批量购买请联系 support@sipeed.com 。
+

docs/doc/zh/basic/app.md

@@ -9,9 +9,10 @@ title: 应用开发和应用商店
 
 * **[应用商店](https://maixhub.com/app)**： 开发者上传分享应用，用户无需开发直接下载使用，开发者可以获取到一定的现金收益（来自 MaixHub 官方以及用户打赏）。
 * **出厂内置大量应用**： 官方提供了一些常用的应用，比如找色块、AI 物体检测追踪、找二维码、人脸识别等等，用户可以直接使用，也可以作为串口模块直接使用。
-* **MaixPy + MaixCDK** 软件开发包：使用 MaixPy 或者 MaixCDK 可以用 Python 或者 C/C++ 语言快速开发嵌入式 AI 视觉听觉应用，超高效率实现你的有趣想法。
+* **MaixPy + MaixCDK** 软件开发包：使用 [MaixPy](https://github.com/sipeed/maixpy) 或者 [MaixCDK](https://github.com/sipeed/MaixCDK) 可以用 Python 或者 C/C++ 语言快速开发嵌入式 AI 视觉听觉应用，超高效率实现你的有趣想法。
 * **MaixVision** 配套电脑端开发工具: 全新的电脑端代码开发工具，快速上手、调试、运行、上传代码、安装应用到设备，一键式开发，甚至支持图像化积木式编程，小学生也能轻松上手。
 
+大家可以多多关注应用商店，也可以在应用商店中分享自己的应用，大家一起共建活跃的社区。