coscene-io
diff --git a/‎.github/workflows/deploy-to-gh-pages.yml
+62 b/‎.github/workflows/deploy-to-gh-pages.yml
+62
diff --git a/‎.gitignore
+3 b/‎.gitignore
+3
diff --git a/‎docs/coStudio/1-connect-by-cobridge.md renamed to ‎docs/client/1-connect-by-cobridge.md
+17-10 b/‎docs/coStudio/1-connect-by-cobridge.md renamed to ‎docs/client/1-connect-by-cobridge.md
+17-10
diff --git a/‎docs/client/2-apt-source-install.md
+49 b/‎docs/client/2-apt-source-install.md
+49
diff --git a/‎docs/client/_category_.json
+9 b/‎docs/client/_category_.json
+9
diff --git a/‎docs/client/img/1-open-connection.png
264 KB b/‎docs/client/img/1-open-connection.png
264 KB
diff --git a/‎docs/coStudio/img/1-3-realtime-viz-cn.png renamed to ‎docs/client/img/1-realtime-viz.png b/‎docs/coStudio/img/1-3-realtime-viz-cn.png renamed to ‎docs/client/img/1-realtime-viz.png
diff --git a/‎docs/client/img/1-select-connection.png
219 KB b/‎docs/client/img/1-select-connection.png
219 KB
diff --git a/‎docs/client/img/2-install-cobridge.png
15.1 KB b/‎docs/client/img/2-install-cobridge.png
15.1 KB
diff --git a/‎docs/client/img/2-install-colistener.png
14.4 KB b/‎docs/client/img/2-install-colistener.png
14.4 KB
diff --git a/‎docs/client/img/2-install-costudio.png
10.2 KB b/‎docs/client/img/2-install-costudio.png
10.2 KB
diff --git a/‎docs/coStudio/_category_.json
-10 b/‎docs/coStudio/_category_.json
-10
diff --git a/‎docs/coStudio/img/1-1-open-connection-cn.png
-77.8 KB b/‎docs/coStudio/img/1-1-open-connection-cn.png
-77.8 KB
diff --git a/‎docs/coStudio/img/1-2-select-connection-cn.png
-62.8 KB b/‎docs/coStudio/img/1-2-select-connection-cn.png
-62.8 KB
@@ -0,0 +1,62 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node env
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build website with English locale
+        run: |
+          # Temporarily modify the default locale to English
+          sed -i 's/defaultLocale: '\''zh'\''/defaultLocale: '\''en'\''/' docusaurus.config.js
+
+          # Uncomment and update Algolia search path for GitHub Pages deployment
+          sed -i '/replaceSearchResultPathname: {/,/},/ s/^        \/\/ /        /' docusaurus.config.js
+          sed -i 's|from: '\''/docs/'\''|from: '\''/en/'\''|' docusaurus.config.js
+
+          pnpm build
+          echo "docs.coscene.io" > ./build/CNAME
+
+      - name: Deploy to GH Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build
+
+      - name: Notification to Feishu
+        uses: foxundermoon/feishu-action@v2
+        with:
+          url: ${{ secrets.FEISHU_BOT_WEBHOOK_URL_RHODE_ISLAND }}
+          msg_type: text
+          content: |
+            text: |
+              🚀 coScene Docs 海外版本部署完成
+              👨‍💻 部署人员：${{ github.actor }}
+              🔗 访问地址：https://docs.coscene.io
@@ -30,3 +30,6 @@ yarn-error.log*
 
 # generated pdf files
 /pdf
+
+# env
+.env
@@ -7,45 +7,52 @@ sidebar_position: 1
 [coBridge](https://github.com/coscene-io/coBridge) 是刻行时空提供的一款开源机端软件，目前支持 **ros1** `noetic`、 **ros2** `foxy` 及 `humble` 版本。cobridge 会以 ros node 的方式运行在机器人端，并通过 websocket 方式与云端进行交互。cobridge 与云端建立链接后，根据云端指令可以实现订阅 ros topic，调用 ros service，实现实时监控机器人状态、远程下发指令等功能。
 
 ## 安装 coBridge
+
 在机器端，打开 terminal，依照以下流程安装 coBridge。
+
 1. 导入公钥。
+
 ```bash
-  wget https://coscene-download.oss-cn-hangzhou.aliyuncs.com/cobridge/coscene.gpg && sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/coscene.gpg coscene.gpg
+  wget https://download.coscene.cn/cobridge/coscene.gpg && sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/coscene.gpg coscene.gpg
 ```
 
 2. 添加源。
+
 ```bash
-  echo "deb [signed-by=/etc/apt/trusted.gpg.d/coscene.gpg] https://coscene-download.oss-cn-hangzhou.aliyuncs.com/cobridge $(. /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/cobridge.list
+  echo "deb [signed-by=/etc/apt/trusted.gpg.d/coscene.gpg] https://download.coscene.cn/cobridge $(. /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/cobridge.list
 ```
 
 3. 更新apt并安装。
+
 ```bash
   sudo apt update
   # 注意: 如果 ROS_DISTRO 没有在你的环境变量里面，${ROS_DISTRO} 需要被 'noetic', 'foxy' or 'humble' 替换
   sudo apt install ros-${ROS_DISTRO}-cobridge -y
 ```
 
 4. 运行 coBridge。
+
 ```bash
   source /opt/ros/${ROS_DISTRO}/setup.bash
-  
+
   # for ros 1 distribution
   roslaunch cobridge cobridge.launch
-  
+
   # for ros 2 distribution
-  ros2 launch cobridge cobridge_launch.xml 
+  ros2 launch cobridge cobridge_launch.xml
 ```
 
 ## 使用 coStudio 对机器进行实时可视化
+
 1. 下载 [coStudio](https://www.coscene.cn/download)。
 2. 开启 coStudio 后，选择 “打开连接” 功能。
-![打开连接](./img/1-1-open-connection-cn.png)
+   ![打开连接](./img/1-open-connection.png)
 3. 选择 coScene Websocket 选项，在 WebSocket URL 中输入连接地址。`ws://localhost:21274` **（ 21274 为 coBridge 的默认端口号 ）**。
-![选择连接](./img/1-2-select-connection-cn.png)
+   ![选择连接](./img/1-select-connection.png)
 4. 打开后即可使用不同面板对机器数据进行实时可视化。
-![实时可视化](./img/1-3-realtime-viz-cn.png)
+   ![实时可视化](./img/1-realtime-viz.png)
 
 ## 可视化相关参考链接
-  * 面板相关设置：[面板设置](https://docs.coscene.cn/docs/category/panel)
-  * 布局相关设置：[布局](https://docs.coscene.cn/docs/viz/layout)
 
+- 面板相关设置：[面板设置](https://docs.coscene.cn/docs/category/panel)
+- 布局相关设置：[布局](https://docs.coscene.cn/docs/viz/layout)
@@ -0,0 +1,49 @@
+---
+sidebar_position: 2
+---
+
+# 通过 APT 安装 coScene 软件
+
+## 添加 coScene GPG key
+
+``` bash
+curl -fsSL https://apt.coscene.cn/coscene.gpg | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/coscene.gpg
+```
+
+## 添加仓库到源列表
+
+``` bash
+echo "deb [signed-by=/etc/apt/trusted.gpg.d/coscene.gpg] https://apt.coscene.cn $(. /etc/os-release && echo $UBUNTU_CODENAME) main stable" | sudo tee /etc/apt/sources.list.d/coscene.list
+```
+
+## 更新 APT 仓库
+
+```bash
+sudo apt update
+```
+
+## 安装软件
+
+APT 仓库更新后，你就可以安装 coScene 的软件了。
+
+* coStudio
+
+  ![安装coStudio](./img/2-install-costudio.png)
+  ```bash
+  sudo apt install coStudio 
+  ```
+  
+* coBridge
+
+  ![安装coBridge](./img/2-install-cobridge.png)
+  ```bash
+  sudo apt install ros-${ROS_DISTRO}-cobridge
+  ```
+
+* coListener
+
+  ![安装coListener](./img/2-install-colistener.png)
+  ```bash
+  sudo apt install ros-${ROS_DISTRO}-colistener
+  ```
+  
@@ -0,0 +1,9 @@
+{
+  "label": "客户端",
+  "position": 12,
+  "collapsible": true,
+  "link": {
+    "type": "generated-index",
+    "slug": "/category/client"
+  }
+}
-Original file line number
+Diff line change
 # generated pdf files
 /pdf
++
 +# env
 +.env