Update.

Author: Jiu-xiao

docs/code_gen/stm32/README.md

@@ -34,13 +34,13 @@ xr_cubemx_cfg -d .
 [INFO] LibXR submodule already exists. Checking for updates...
 [INFO] [OK] cd . && git submodule update --init --recursive
 [INFO] LibXR submodule updated.
-Found .ioc file: .\atom.ioc
+Found .ioc file: ./atom.ioc
 Parsing .ioc file...
-[INFO] [OK] xr_parse_ioc -d . -o .\.config.yaml
+[INFO] [OK] xr_parse_ioc -d . -o ./.config.yaml
 Generating C++ code...
-[INFO] [OK] xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp
+[INFO] [OK] xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp
 Modifying STM32 interrupt files...
-[INFO] [OK] xr_stm32_it .\Core/Src
+[INFO] [OK] xr_stm32_it ./Core/Src
 [INFO] [OK] xr_stm32_cmake .
 [INFO] [Pass] All tasks completed successfully!
 ```
@@ -62,7 +62,7 @@ Modifying STM32 interrupt files...
 ├── Core/Src/stm32f1xx_it.c           # 补丁后的中断处理函数
 ├── cmake/LibXR.CMake                 # LibXR 构建配置
 ├── CMakeLists.txt                    # 自动集成 LibXR
-└── Middlewares\Third_Party\LibXR     # Git 子模块：LibXR 本体
+└── Middlewares/Third_Party/LibXR     # Git 子模块：LibXR 本体
 ```
 
 ---

docs/code_gen/stm32/adc.md

@@ -43,4 +43,4 @@ ADC:
 可直接修改该文件。如需应用更新配置，请执行以下任一命令以重新生成代码：  
 `xr_cubemx_cfg -d .`  
 或  
-`xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp`
+`xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp`

docs/code_gen/stm32/can.md

@@ -36,4 +36,4 @@ FDCAN:
 可直接修改该配置文件。如需应用更改，请执行以下命令重新生成代码：  
 `xr_cubemx_cfg -d .`  
 或  
-`xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp`
+`xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp`

docs/code_gen/stm32/i2c.md

@@ -33,4 +33,4 @@ I2C:
 可直接修改该文件。如需应用更新配置，请执行以下任一命令以重新生成代码：  
 `xr_cubemx_cfg -d .`  
 或  
-`xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp`
+`xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp`

docs/code_gen/stm32/spi.md

@@ -31,4 +31,4 @@ SPI:
 可直接修改该文件。如需应用更新配置，请执行以下任一命令以重新生成代码：  
 `xr_cubemx_cfg -d .`  
 或  
-`xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp`
+`xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp`

docs/code_gen/stm32/timer.md

@@ -42,7 +42,7 @@ PlatformInit(2, 512);
 
 ## 配置文件
 
-对于非裸机环境，会在`User\libxr_config.yaml`中生成如下配置:
+对于非裸机环境，会在`User/libxr_config.yaml`中生成如下配置:
 
 ```yaml
 software_timer:
@@ -53,4 +53,4 @@ software_timer:
 可直接修改该文件。如需应用更新配置，请执行以下任一命令以重新生成代码：  
 `xr_cubemx_cfg -d .`  
 或  
-`xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp`
+`xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp`

docs/code_gen/stm32/uart.md

@@ -64,4 +64,4 @@ USB:
 可直接修改该文件。如需应用更新配置，请执行以下任一命令以重新生成代码：  
 `xr_cubemx_cfg -d .`  
 或  
-`xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp`
+`xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp`

docs/code_gen/xrobot_inter.md

@@ -0,0 +1,50 @@
+---
+id: code-gen-xrobot-inter
+title: 与XRobot集成
+sidebar_position: 2
+---
+
+# 与XRobot集成
+
+在代码生成时加入`--xrobot`选项，可以生成对应的硬件容器（LibXR::HardwareContainer）以供XRobot初始化。
+
+## 示例
+
+```bash
+xr_gen_code_stm32 -i .\.config.yaml -o .\User\app_main.cpp --xrobot
+[INFO] Detected FreeRTOS configuration
+[INFO] FlashLayout is generated and injected, MCU: STM32G431KBU6
+[INFO] Flash layout map written to: .\User\flash_map.hpp
+[INFO] Successfully generated: .\User
+[INFO] Generated header file: app_main.h
+```
+
+会在app_main.cpp中额外生成以下代码：
+
+```cpp
+  LibXR::HardwareContainer<
+    LibXR::Entry<LibXR::PowerManager>,
+    ...
+  > peripherals{
+    LibXR::Entry<LibXR::PowerManager>(power_manager)
+    ...
+  };
+
+  XRobotMain(peripherals);
+```
+
+同时在libxr_config.yaml中添加外设别名，上层代码可依靠这些别名访问外设：
+
+```yaml
+device_aliases:
+  power_manager:
+    type: PowerManager
+    aliases:
+    - power_manager
+  LED:
+    type: GPIO
+    aliases:
+    - LED
+    - led_red
+  ...
+```

docs/proj_man/add_mod.md

@@ -0,0 +1,46 @@
+---
+id: proj-man-add-mod
+title: 添加模块
+sidebar_position: 4
+---
+
+# 添加模块
+
+通过`xrobot_add_mod`工具可以快速添加一个新模块到仓库，或者从仓库中选择一个模块创建实例。
+
+## 使用方法
+
+### 添加远程模块到仓库
+
+--version可以省略，使用时要确保对应分支存在。
+
+```bash
+$ xrobot_add_mod https://github.com/yourorg/BlinkLED.git --version main
+[SUCCESS] Added repo module 'BlinkLED' to Modules/modules.yaml
+```
+
+然后拉取模块：
+
+```bash
+$ xrobot_init_mod
+[INFO] Cloning new module: BlinkLED
+Cloning into 'Modules/BlinkLED'...
+remote: Enumerating objects: 22, done.
+remote: Counting objects: 100% (22/22), done.
+remote: Compressing objects: 100% (15/15), done.
+remote: Total 22 (delta 7), reused 22 (delta 7), pack-reused 0 (from 0)
+Receiving objects: 100% (22/22), done.
+Resolving deltas: 100% (7/7), done.
+[SUCCESS] All modules processed
+```
+
+### 创建模块实例
+
+```bash
+$ xrobot_add_mod BlinkLED
+[SUCCESS] Appended module instance 'BlinkLED' to User/xrobot.yaml
+
+# 重新生成代码
+$ xrobot_gen_main
+...
+```

docs/proj_man/create_mod.md

@@ -0,0 +1,53 @@
+---
+id: proj-man-create-mod
+title: 快速创建模块
+sidebar_position: 3
+---
+
+XRobot 提供了快速创建模块的工具 `xrobot_create_mod`，可以从模板中快速创建一个新模块，用于快速开发模块，无需手动创建模块仓库和模块头文件。
+
+## 使用方法
+
+```bash
+$ xrobot_create_mod MySensor --desc "IMU interface module" --hw imu scl sda
+[OK] Module MySensor generated at Modules/MySensor
+```
+
+通过xrobot_mod_parser查看模块信息：
+
+```bash
+$ xrobot_mod_parser --path ./Modules/MySensor/
+
+=== Module: MySensor ===
+Description       : IMU interface module
+
+Constructor Args  :
+  - name               = your_arg_name_here
+
+Required Hardware : imu scl sda
+```
+
+模块的目录结构如下:
+
+```bash
+Modules/
+└── BlinkLED/
+    ├── BlinkLED.hpp        # 带 manifest 的头文件
+    ├── README.md           # 模块文档
+    └── CMakeLists.txt      # 构建配置
+```
+
+标准的MANIFEST（模块信息）格式如下：
+
+```yaml
+// clang-format off
+/* === MODULE MANIFEST ===
+module_name: BlinkLED
+module_description: 控制 LED 闪烁的简单模块 / A simple module to control LED blinking
+constructor_args:
+  - blink_cycle: 250
+required_hardware: led/LED/led1/LED1
+repository: https://github.com/xrobot-org/BlinkLED
+=== END MANIFEST === */
+// clang-format on
+```