From 28d914b63cc87699d8b59bc41075ce0520b0522f Mon Sep 17 00:00:00 2001 From: stydxm Date: Wed, 12 Jun 2024 02:08:50 +0800 Subject: [PATCH 1/2] add broken gazebo logo --- src/theme/sections/get-started/get-started.js | 4 +- static/img/homepage/gazebo.svg | 150 ++++++++++++++++++ 2 files changed, 151 insertions(+), 3 deletions(-) create mode 100644 static/img/homepage/gazebo.svg diff --git a/src/theme/sections/get-started/get-started.js b/src/theme/sections/get-started/get-started.js index 7f108e6..d35c6ca 100644 --- a/src/theme/sections/get-started/get-started.js +++ b/src/theme/sections/get-started/get-started.js @@ -30,9 +30,7 @@ export default function GetStarted() { }, { bg: useBaseUrl("img/ic-plugin-bg.svg"), - icon: useBaseUrl( - "http://gazebosim.org/assets/logos/gazebo_vert_pos-faad8cc37ab336f850e549077ef5831e5098034532113b06328dfd70355fb8f7.svg" - ), + icon: useBaseUrl("img/homepage/gazebo.svg"), type: "plugin", label: ( + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + From 0487db8526b1d64b361dc9c9f95bd0cc2d20c5d6 Mon Sep 17 00:00:00 2001 From: stydxm Date: Wed, 12 Jun 2024 03:01:46 +0800 Subject: [PATCH 2/2] docs: a bunch of typo and broken links --- current_docs/dev_guide/code_style.md | 2 +- current_docs/dev_guide/ide_config.md | 3 ++- current_docs/digging_deeper/rt_test.md | 4 +++- .../overview/hardware_specifications.md | 2 +- current_docs/quick_start/rm_controls101_.md | 2 +- docusaurus.config.js | 8 +++---- i18n/en/README.md | 2 +- .../current/dev_guide/code_style.md | 2 +- .../current/dev_guide/ide_config.md | 3 ++- .../current/dev_guide/ide_config_en.md | 22 ------------------- .../current/digging_deeper/rt_kernel.md | 2 +- .../current/digging_deeper/rt_test.md | 6 +++-- .../digging_deeper/theory/bullet_solver.md | 2 +- .../overview/hardware_specifications.md | 4 ++-- .../current/overview/software_framework.md | 2 +- .../current/overview/why_rm-controls.md | 2 +- 16 files changed, 26 insertions(+), 42 deletions(-) delete mode 100644 i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config_en.md diff --git a/current_docs/dev_guide/code_style.md b/current_docs/dev_guide/code_style.md index 5f5d267..6d5aca0 100644 --- a/current_docs/dev_guide/code_style.md +++ b/current_docs/dev_guide/code_style.md @@ -106,7 +106,7 @@ clang-format 需要在 catkin 工作区的根目录下有一个配置文件，rm :::tip -使用命令行太头疼了? 试试 [CLion IDE 配置 ](./ide_config). +使用命令行太头疼了? 试试 [CLion IDE 配置 ](./clion_ide_config). ::: diff --git a/current_docs/dev_guide/ide_config.md b/current_docs/dev_guide/ide_config.md index a4a8a41..2e7fb3a 100644 --- a/current_docs/dev_guide/ide_config.md +++ b/current_docs/dev_guide/ide_config.md @@ -9,7 +9,8 @@ sidebar_position: 2 ## ROS 配置 -参考 [ROS setup tutorial](https://www.jetbrains.com/help/clion/ros-setup-tutorial.html) 此外，为了兼容 `catkin build` 和 `catkin_make` 应作如下设置 +参考 [ROS setup tutorial](https://www.jetbrains.com/help/clion/ros-setup-tutorial.html) +此外，为了兼容 `catkin build` 和 `catkin_make` 应作如下设置 - 打开 **File | Settings | Build, Execution, Deployment | CMake** - 将 **CMake options** 的值更改为 `-DCATKIN_DEVEL_PREFIX=../devel` diff --git a/current_docs/digging_deeper/rt_test.md b/current_docs/digging_deeper/rt_test.md index 2820843..8939719 100644 --- a/current_docs/digging_deeper/rt_test.md +++ b/current_docs/digging_deeper/rt_test.md @@ -12,7 +12,9 @@ sidebar_position: 4 ## 安装脚本依赖 -`sudo apt install rt-tests stress gnuplot` +```shell +sudo apt install rt-tests stress gnuplot +``` ## 进行测试 diff --git a/current_docs/overview/hardware_specifications.md b/current_docs/overview/hardware_specifications.md index f57fe9a..055c357 100644 --- a/current_docs/overview/hardware_specifications.md +++ b/current_docs/overview/hardware_specifications.md @@ -27,7 +27,7 @@ Jetson AGX Xavier/NX/TX2 和 妙算 2-G（TX2）都具有两个 build-in 的 CAN ## 其他接口 -GPIO、PWM、I2C 接口正在开发中，详见 [road map](TODO)。 +GPIO、PWM、I2C 接口正在开发中，详见 [road map](road_map)。 ## 模块拓扑 diff --git a/current_docs/quick_start/rm_controls101_.md b/current_docs/quick_start/rm_controls101_.md index 212cc18..a67cb50 100644 --- a/current_docs/quick_start/rm_controls101_.md +++ b/current_docs/quick_start/rm_controls101_.md @@ -200,7 +200,7 @@ mkdir urdf launch config #### 从包安装 -请先[添加源](https://rm-controls.github.io/quick_start/rm_source) +请先[添加源](/quick_start/rm_source) sudo apt install ros-noetic-rm-hw diff --git a/docusaurus.config.js b/docusaurus.config.js index 251d9e9..88f0387 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -7,13 +7,13 @@ const katex = require("rehype-katex"); module.exports = { title: "rm-controls documentation", tagline: "", - url: "https://rm-controls.github.io", + url: "https://rm-control-docs.netlify.app", baseUrl: "/", onBrokenLinks: "warn", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", organizationName: "rm-controls", - projectName: "rm-controls.github.io", + projectName: "rm-control-website", trailingSlash: false, i18n: { defaultLocale: "zh-CN", @@ -100,12 +100,12 @@ module.exports = { routeBasePath: "/", sidebarPath: require.resolve("./sidebars.js"), editUrl: - "https://github.com/rm-controls/rm-controls.github.io/tree/master", + "https://github.com/rm-controls/rm-control-website/tree/master", }, blog: { showReadingTime: true, editUrl: - "https://github.com/rm-controls/rm-controls.github.io/tree/master", + "https://github.com/rm-controls/rm-control-website/tree/master", }, theme: { customCss: require.resolve("./src/scss/application.scss"), diff --git a/i18n/en/README.md b/i18n/en/README.md index 7b3d64b..95b8f20 100644 --- a/i18n/en/README.md +++ b/i18n/en/README.md @@ -1,3 +1,3 @@ -# Copyed from rm-controls.github.io +# Copyed from rm-control-docs.netlify.app ## It is the english version diff --git a/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/code_style.md b/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/code_style.md index 4d2ae1c..5f0149e 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/code_style.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/code_style.md @@ -113,7 +113,7 @@ But please use it carefully. :::tip -Too much of a headache to use the command line? Try [CLion IDE configuration](. /ide_config). +Too much of a headache to use the command line? Try [CLion IDE configuration](./clion_ide_config). ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config.md b/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config.md index dc0840c..9f89113 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config.md @@ -9,7 +9,8 @@ We recommend using CLion IDE as the development IDE for electric and vision, see ## ROS configuration -Refer to the [ROS setup tutorial](https://www.jetbrains.com/help/clion/ros-setup-tutorial.html) In addition, for compatibility with `catkin build` and `catkin_make` the following settings should be made +Refer to the [ROS setup tutorial](https://www.jetbrains.com/help/clion/ros-setup-tutorial.html) +In addition, for compatibility with `catkin build` and `catkin_make` the following settings should be made - open **File | Settings | Build, Execution, Deployment | CMake** - Change the value of **CMake options** to `-DCATKIN_DEVEL_PREFIX=. /devel` diff --git a/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config_en.md b/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config_en.md deleted file mode 100644 index 6fffe24..0000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/dev_guide/ide_config_en.md +++ /dev/null @@ -1,22 +0,0 @@ -# IDE configuration - -For the download and basic configuration of CLion, please refer to [Install CLion](https://www.jetbrains.com/help/clion/installation-guide.html). - -## Auto format - -- Go to **File | Settings | Plugins**, search for and install **Save Actions** in the marketplace -- Restart IDE, go to **File | Settings | Save Actions**, and check the following options: - -![save_actions](https://s3.ax1x.com/2020/11/16/Dk9fXD.png) - -- Go to **File | Settings | Editor | Code Style | C/C++**, click **Set from...** on the right and select **Google**. - -## ROS configuration - -- Go to **File | Settings | Build, Execution, Deployment | CMake** -- Change the value of **CMake options** to `-DCATKIN_DEVEL_PREFIX=../devel` -- Change the value of **Build directory** to `../build` - -## Remote development - -- For the remote development, please refer to [Full remote mode](https://www.jetbrains.com/help/clion/remote-projects-support.html). diff --git a/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_kernel.md b/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_kernel.md index 5adc2f6..72f75f4 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_kernel.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_kernel.md @@ -3,7 +3,7 @@ id: rt_kernel sidebar_position: 3 --- -# Real-time kernel compilation +# Real-time Kernel Compilation The [RT-Preempt](https://rt.wiki.kernel.org/index.php/Main_Page) is based on the Linux community kernel, with relevant patches to make Linux meet hard real-time requirements. Here is the compilation and configuration process, using kernel `5.6.19` as an example. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_test.md b/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_test.md index 2a7633c..5954044 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_test.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/rt_test.md @@ -3,7 +3,7 @@ id: rt_test sidebar_position: 4 --- -## Test kernel real-time +# Test Kernel Real-time ## Install the test script @@ -12,7 +12,9 @@ Just pull this repository locally. ## Install script dependencies -`sudo apt install rt-tests stress gnuplot` +```shell +sudo apt install rt-tests stress gnuplot +``` ## Run the test diff --git a/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/theory/bullet_solver.md b/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/theory/bullet_solver.md index 28cf017..a48b7b5 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/theory/bullet_solver.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/digging_deeper/theory/bullet_solver.md @@ -2,7 +2,7 @@ sidebar_position: 2 --- -## Barrel angle solver +# Barrel Angle Solver ## Overview diff --git a/i18n/en/docusaurus-plugin-content-docs/current/overview/hardware_specifications.md b/i18n/en/docusaurus-plugin-content-docs/current/overview/hardware_specifications.md index c817f7c..9c88e9a 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/overview/hardware_specifications.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/overview/hardware_specifications.md @@ -3,7 +3,7 @@ id: hardware_specifications sidebar_position: 2 --- -## Hardware Specifications +# Hardware Specifications ## CAN bus @@ -27,7 +27,7 @@ The following picture shows: Stable connection of the USB to CAN module using th ## Other interfaces -GPIO, PWM, I2C interfaces are under development, see [road map](TODO) for details. +GPIO, PWM, I2C interfaces are under development, see [road map](road_map) for details. ## Module topology diff --git a/i18n/en/docusaurus-plugin-content-docs/current/overview/software_framework.md b/i18n/en/docusaurus-plugin-content-docs/current/overview/software_framework.md index 7746a6e..e392a8c 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/overview/software_framework.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/overview/software_framework.md @@ -3,7 +3,7 @@ id: software_framework sidebar_position: 3 --- -# Software framework +# Software Framework ## rm-controls diff --git a/i18n/en/docusaurus-plugin-content-docs/current/overview/why_rm-controls.md b/i18n/en/docusaurus-plugin-content-docs/current/overview/why_rm-controls.md index c692101..7ce331e 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/overview/why_rm-controls.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/overview/why_rm-controls.md @@ -3,7 +3,7 @@ id: intro sidebar_position: 1 --- -## Why rm-controls? +# Why rm-controls? ## Very high code reuse rate