Repository: robustmq/robustmq (language: rust)

Issue:
docs: help us build docs website
### What type of enhancement is this?

Other

### What does the enhancement do?

Use vitepress to build docs witesite

### Implementation challenges

_No response_


Discussion / hints:

Fix patch:
diff --git a/docs/.vitepress/src/sidebars/en.mts b/docs/.vitepress/src/sidebars/en.mts
index 656d02dc2..da382cef3 100644
--- a/docs/.vitepress/src/sidebars/en.mts
+++ b/docs/.vitepress/src/sidebars/en.mts
@@ -53,7 +53,7 @@ export const sidebar = [
             {text: "VsCode", link: "/ContributionGuide/VsCode-Running"},
             {text: "Code Structure", link: "/ContributionGuide/Code-Structure"},
             {text: "Contribution Guide", link: "/ContributionGuide/GitHub-Contribution-Guide"},
-            {text: "PR Example", link: "/ContributionGuide/GitHub-Pull-Request-Example"},
+            {text: "PR Example", link: "/ContributionGuide/Pull-Request-Example"},
         ],
     },
     {
diff --git a/docs/.vitepress/src/sidebars/zh.mts b/docs/.vitepress/src/sidebars/zh.mts
index f078a213c..28eb03714 100644
--- a/docs/.vitepress/src/sidebars/zh.mts
+++ b/docs/.vitepress/src/sidebars/zh.mts
@@ -53,7 +53,7 @@ export const sidebar = [
             {text: "VsCode 运行", link: "/zh/ContributionGuide/VsCode-Running"},
             {text: "代码结构", link: "/zh/ContributionGuide/Code-Structure"},
             {text: "GitHub 贡献指南", link: "/zh/ContributionGuide/GitHub-Contribution-Guide"},
-            {text: "PR 提交示例", link: "/zh/ContributionGuide/GitHub-Pull-Request-Example"},
+            {text: "PR 提交示例", link: "/zh/ContributionGuide/Pull-Request-Example"},
         ],
     },
     {
diff --git a/docs/en/Architect/Configuration/Placement-Center.md b/docs/en/Architect/Configuration/Placement-Center.md
index 0bf700b63..65b3de29d 100644
--- a/docs/en/Architect/Configuration/Placement-Center.md
+++ b/docs/en/Architect/Configuration/Placement-Center.md
@@ -1,4 +1,5 @@
 # Configuration Description
+
 ## Cluster Name
 ```
 # Define the cluster name, used to identify the current cluster, default name placement-center
diff --git a/docs/en/Architect/OverView.md b/docs/en/Architect/Overview.md
similarity index 100%
rename from docs/en/Architect/OverView.md
rename to docs/en/Architect/Overview.md
diff --git a/docs/en/ContributionGuide/Github-Pull-Request-Example.md b/docs/en/ContributionGuide/Pull-Request-Example.md
similarity index 100%
rename from docs/en/ContributionGuide/Github-Pull-Request-Example.md
rename to docs/en/ContributionGuide/Pull-Request-Example.md
diff --git a/docs/zh/Architect/Broker-Server.md b/docs/zh/Architect/Broker-Server.md
index 26b2558e8..5f46ab391 100644
--- a/docs/zh/Architect/Broker-Server.md
+++ b/docs/zh/Architect/Broker-Server.md
@@ -1,3 +1,5 @@
+# Broker Server
+## 概览
 Broker Server是计算层组件，主要完成各种不同消息协议的数据接入及其相关功能的实现。从设计角度来看，它希望支持MQTT 3.1/3.1.1/5.0、AMQP、RocketMQ Remoting/GRPC、Kafka Protocol、OpenMessing、JNS、SQS等主流消息协议。架构如下：
 ![image](../../images/doc-image2.png)
 
diff --git a/docs/zh/Architect/Configuration/Mqtt-Server.md b/docs/zh/Architect/Configuration/Mqtt-Server.md
index 71f2f14ec..aae65266e 100644
--- a/docs/zh/Architect/Configuration/Mqtt-Server.md
+++ b/docs/zh/Architect/Configuration/Mqtt-Server.md
@@ -1,7 +1,6 @@
+# Mqtt Broker配置说明
 
-## 配置说明
-
-### 基础配置
+## 基础配置
 ```
 # 定义MQTT Broker集群的名称，用于标识和管理
 cluster_name = "mqtt-broker"
@@ -19,7 +18,7 @@ http_port = 9982
 placement_center = ["127.0.0.1:1228"]
 ```
 
-### 网络配置
+## 网络配置
 ```
 [network]
 # MQTT协议, 默认1883和8883
@@ -38,7 +37,7 @@ tls_cert = "./config/example/certs/cert.pem"
 tls_key = "./config/example/certs/key.pem"
 ```
 
-### TCP协议相关配置
+## TCP协议相关配置
 ```
 [tcp_thread]
 # 接受客户端连接的线程数量, 默认1
@@ -66,7 +65,7 @@ lock_max_try_mut_times = 30
 lock_try_mut_sleep_time_ms = 50
 ```
 
-### 系统配置
+## 系统配置
 ```
 [system]
 # 运行时工作线程数, 默认16
@@ -77,7 +76,7 @@ default_user = "admin"
 default_password = "pwd123"
 ```
 
-### 存储配置
+## 存储配置
 ```
 [storage]
 # 存储类型, 默认为memory, 支持memory, mysql
@@ -85,7 +84,7 @@ storage_type = "memory"
 mysql_addr = ""
 ```
 
-### 认证配置
+## 认证配置
 ```
 [auth]
 storage_type = "placement"
@@ -93,7 +92,7 @@ journal_addr = ""
 mysql_addr = ""
 ```
 
-### 日志配置
+## 日志配置
 ```
 [log]
 # 日志配置文件路径, 默认./config/log4rs.yaml
diff --git a/docs/zh/Architect/Configuration/Placement-Center.md b/docs/zh/Architect/Configuration/Placement-Center.md
index d121f1b45..b946abaa9 100644
--- a/docs/zh/Architect/Configuration/Placement-Center.md
+++ b/docs/zh/Architect/Configuration/Placement-Center.md
@@ -1,11 +1,11 @@
-## 配置说明
-###  集群名称
+# Placement-Center 配置说明
+##  集群名称
 ```
 # 定义集群名称，用于标识当前集群, 默认名字placement-center
 cluster_name = "placement-test"
 ```
 
-### 节点相关配置
+## 节点相关配置
 ```
 [node]
 # 定义节点ID，用于唯一标识当前节点，默认1
@@ -17,7 +17,7 @@ addr = "127.0.0.1"
 # 定义节点列表，包含节点ID和对应的gRPC地址
 nodes = { 1 = "127.0.0.1:1228" }
 ```
-### 网络相关配置
+## 网络相关配置
 ```
 [network]
 # 定义节点的gRPC服务端口
@@ -26,13 +26,13 @@ grpc_port = 1228
 # 定义节点的HTTP服务端口，用于获取集群状态,节点等信息
 http_port = 1227
 ```
-### 进程相关参数
+## 进程相关参数
 ```
 [system]
 # 定义运行时线程数量 runtime_work_threads * 2
 runtime_work_threads = 100
 ```
-### Broker 节点心跳检测相关参数
+## Broker 节点心跳检测相关参数
 ```
 [heartbeat]
 # 定义心跳超时时间，单位为毫秒，用于检测节点故障，默认30000
@@ -42,7 +42,7 @@ heartbeat_timeout_ms = 30000
 heartbeat_check_time_ms = 1000
 ```
 
-### RocksDB 相关配置
+## RocksDB 相关配置
 ```
 [rocksdb]
 # 定义数据存储路径，rocksdb
@@ -52,7 +52,7 @@ data_path = "./robust-data/placement-center/data"
 max_open_files = 10000
 
 ```
-### 日志配置，指定日志路径和配置文件
+## 日志配置，指定日志路径和配置文件
 ```
 [log]
 # 日志配置文件路径，默认./config/log4rs.yaml
diff --git a/docs/zh/Architect/Journal-Server.md b/docs/zh/Architect/Journal-Server.md
index 35e57b06e..eb14e4114 100644
--- a/docs/zh/Architect/Journal-Server.md
+++ b/docs/zh/Architect/Journal-Server.md
@@ -1,3 +1,5 @@
+# Journal Server
+## 概览
 Storage Engine（后面简称SE）是独立的存储服务，它负责消息数据的持久存储，需要兼顾性能、可靠性和成本。它以GRPC 协议（GRPC协议可能会有性能瓶颈，待后续调整）的形式暴露服务。架构如下：
 ![image](../../images/doc-image3.png)
 
diff --git a/docs/zh/Architect/OverView.md b/docs/zh/Architect/Overview.md
similarity index 99%
rename from docs/zh/Architect/OverView.md
rename to docs/zh/Architect/Overview.md
index 33ab376fb..b539f22e5 100644
--- a/docs/zh/Architect/OverView.md
+++ b/docs/zh/Architect/Overview.md
@@ -1,3 +1,4 @@
+# 概览
 RobustMQ 是一个典型的分布式分层架构，计算层、存储层、调度层分离。由控制层（Placement Center）、计算层（Multi-protocol computing layer）、存储适配层（Storage Adapter Layer）、独立的远端存储层（Standalone storage engine） 四个部分组成。每一层都具备快速扩缩容能力，从而达到整个系统具备完整的 Serverless 能力。
 
 ![image](../../images/doc-image.png)
diff --git a/docs/zh/Architect/Placement-Center.md b/docs/zh/Architect/Placement-Center.md
index 8dc98e452..b2785a00c 100644
--- a/docs/zh/Architect/Placement-Center.md
+++ b/docs/zh/Architect/Placement-Center.md
@@ -1,3 +1,5 @@
+# Placement Center
+## 概览
 Placement Center（后面简称PC）是基于 Raft 和 RocksDB 实现一个元数据存储组件。从存储的角度看，它是一个高性能的分布式KV存储服务。从定义上看，它是 Robust Broker 和 Robust Journal 集群的元数据存储、控制和调度中心。架构如下：
 ![image](../../images/doc-image1.png)
 - PC 是一个通过 Raft 协议组成的集群，根据 Raft 协议的定义完成Leader选举，切换、数据一致性等等。
diff --git a/docs/zh/Architect/Test-Case.md b/docs/zh/Architect/Test-Case.md
index 10cd98203..a3b1a8841 100644
--- a/docs/zh/Architect/Test-Case.md
+++ b/docs/zh/Architect/Test-Case.md
@@ -1,3 +1,4 @@
+# 集成测试
 ## 安装 cargo-nextest
 RobustMQ 的集成测试依赖cargo-nextest来加快测试用例的运行速度，所以跑集成测试的时候，需要安装 cargo-nextest。
 
diff --git a/docs/zh/ContributionGuide/Build-Develop-Env.md b/docs/zh/ContributionGuide/Build-Develop-Env.md
index f9ef1cf26..9eafff982 100644
--- a/docs/zh/ContributionGuide/Build-Develop-Env.md
+++ b/docs/zh/ContributionGuide/Build-Develop-Env.md
@@ -1,4 +1,6 @@
-# 基础开发环境搭建(Mac)
+# 基础开发环境搭建
+# Mac环境搭建
+## 主要步骤
 > ⚠️注意：当前项目中已经默认携带了`rust-toolchain.toml`,
 > 因此默认情况下会使用该文件配置的rustc环境，如果通过brew安装了rust
 > 可能会出现版本被覆盖的问题， 需要卸载后重新按照该内容进行搭建
@@ -38,7 +40,7 @@ mac 安装命令如下：
 brew install protobuf
 ```
 
-# 开发pre-commit插件
+### 配置pre-commit插件
 
 RobustMQ默认使用`pre-commit`进行了代码预提交，因此需要安装指定版本的
 `pre-commit`工具。
diff --git a/docs/zh/ContributionGuide/Cargo-Running.md b/docs/zh/ContributionGuide/Cargo-Running.md
index 6645b176f..2f6e98ffa 100644
--- a/docs/zh/ContributionGuide/Cargo-Running.md
+++ b/docs/zh/ContributionGuide/Cargo-Running.md
@@ -1,3 +1,4 @@
+# Cargo运行
 1. Run standalone by placement-center
 ```
 cargo run --package cmd --bin placement-center -- --conf=config/placement-center.toml
diff --git a/docs/zh/ContributionGuide/Code-Structure.md b/docs/zh/ContributionGuide/Code-Structure.md
index bb7946cde..be8c8492e 100644
--- a/docs/zh/ContributionGuide/Code-Structure.md
+++ b/docs/zh/ContributionGuide/Code-Structure.md
@@ -1,3 +1,4 @@
+# 代码结构
 ## 根目录
 
 主要关注： bin、config、docs、makefile、scripts、src、tests 这几个文件和目录.
diff --git a/docs/zh/ContributionGuide/GitHub-Contribution-Guide.md b/docs/zh/ContributionGuide/GitHub-Contribution-Guide.md
index a9a7df4a6..919bf656b 100644
--- a/docs/zh/ContributionGuide/GitHub-Contribution-Guide.md
+++ b/docs/zh/ContributionGuide/GitHub-Contribution-Guide.md
@@ -1,3 +1,4 @@
+# Github贡献指南
 ## 1、创建 ISSUE
 
 ISSUE 范围两类，需求和小的 Fixed，所以在标题层面，需要通过：RBIP-\*和 MINOR 两个前缀来区分。
diff --git a/docs/zh/ContributionGuide/Github-Pull-Request-Example.md b/docs/zh/ContributionGuide/Pull-Request-Example.md
similarity index 99%
rename from docs/zh/ContributionGuide/Github-Pull-Request-Example.md
rename to docs/zh/ContributionGuide/Pull-Request-Example.md
index 51d52adaf..673c33881 100644
--- a/docs/zh/ContributionGuide/Github-Pull-Request-Example.md
+++ b/docs/zh/ContributionGuide/Pull-Request-Example.md
@@ -1,3 +1,4 @@
+# PR 提交示例
 既然你已经看到这里了（[默认基础开发环境您已经配置好了](./Build-Develop-Env.md)），如果你发现了项目的bug或者让你不开心的地方，是不是想亲自下场，那么你可以提交一个 Pull Request 来帮助我们改进。
 
 下面是一个完整的 Pull Request 流程示例，一个修改bug的示例：
diff --git a/docs/zh/ContributionGuide/VsCode-Running.md b/docs/zh/ContributionGuide/VsCode-Running.md
index ded92134e..a515ea729 100644
--- a/docs/zh/ContributionGuide/VsCode-Running.md
+++ b/docs/zh/ContributionGuide/VsCode-Running.md
@@ -1,3 +1,4 @@
+# VSCode运行
 下载项目代码
 初始化环境
 进入src/cmd/src目录，可以看到
diff --git a/docs/zh/OverView/RoadMap.md b/docs/zh/OverView/RoadMap.md
index 16d70198a..21b444eb2 100644
--- a/docs/zh/OverView/RoadMap.md
+++ b/docs/zh/OverView/RoadMap.md
@@ -1,3 +1,4 @@
+# RoadMap
 ## 2024
 2024 年：完善 RobustMQ MQTT, 完善 RobustMQ 的基础能力。
 - 完善 RobustMQ MQTT 的功能
@@ -22,8 +23,8 @@
    3. 集群模式下，Leader 切换，非 Leader 节点的 Controller 暂停，Leader 节点运行 Controller
 2. 压测 Placement Center 服务的性能
 3. 添加 Placement Center 的监控指标
-   
-#### Robust MQTT 
+
+#### Robust MQTT
 > 目标：完成第一阶段，RobustMQ MQTT 集群模式稳定运行。优化当前功能代码、完善测试用例、增加部分功能。
 
 集群模式：
@@ -58,7 +59,7 @@ Dashboard:
 1. 完成 Dashboard 的框架搭建
 2. 完成 Dashboard 和 MQTT Broker 的 Admin 相关接口联动
 
-#### Journal Engine 
+#### Journal Engine
 > 目标：Journal Engine 单节点模式稳定运行
 
 功能:
@@ -80,5 +81,5 @@ Dashboard:
 2. 支持 MySQL
 3. 支持 Redis
 4. 支持 Aws S3
-   
-## 2025 H2
\ No newline at end of file
+
+## 2025 H2
diff --git a/docs/zh/OverView/What-is-RobustMQ.md b/docs/zh/OverView/What-is-RobustMQ.md
index 93b3da95a..d40e38238 100644
--- a/docs/zh/OverView/What-is-RobustMQ.md
+++ b/docs/zh/OverView/What-is-RobustMQ.md
@@ -1,3 +1,4 @@
+# 什么是RobustMQ
 ## 1、定义
 RobustMQ 是一个 100% 用 Rust 实现的中间件消息队列领域的开源项目。它的目标是基于Rust 打造兼容多种主流消息队列协议、具备完整 Serverless 能力的下一代高性能云原生融合型消息队列。
 
diff --git a/docs/zh/OverView/Why-RobustMQ.md b/docs/zh/OverView/Why-RobustMQ.md
index e69de29bb..8796f64fd 100644
--- a/docs/zh/OverView/Why-RobustMQ.md
+++ b/docs/zh/OverView/Why-RobustMQ.md
@@ -0,0 +1,1 @@
+# 为什么有RobustMQ
diff --git a/docs/zh/QuickGuide/Overview.md b/docs/zh/QuickGuide/Overview.md
index f1d86df44..baeec4af3 100644
--- a/docs/zh/QuickGuide/Overview.md
+++ b/docs/zh/QuickGuide/Overview.md
@@ -1,1 +1,2 @@
+# 概览
 RobustMQ 支持 Standalone 和 Cluster 两种模式。需要起来启动Placement Center和Broker Server两个组件。
diff --git a/docs/zh/QuickGuide/Run-Cluster-Mode.md b/docs/zh/QuickGuide/Run-Cluster-Mode.md
index ccb94405f..9f8b11f1e 100644
--- a/docs/zh/QuickGuide/Run-Cluster-Mode.md
+++ b/docs/zh/QuickGuide/Run-Cluster-Mode.md
@@ -1,3 +1,4 @@
+# 集群模式
 1. Download .tar.gz
 ```
 $ tar -xzvf robustmq-v0.0.1-release.tar.gz
diff --git a/docs/zh/QuickGuide/Run-Standalone-Mode.md b/docs/zh/QuickGuide/Run-Standalone-Mode.md
index 5c7a15d6d..d1ae4e18f 100644
--- a/docs/zh/QuickGuide/Run-Standalone-Mode.md
+++ b/docs/zh/QuickGuide/Run-Standalone-Mode.md
@@ -1,3 +1,4 @@
+# 单机模式
 1. Download .tar.gz
 ```
 $ tar -xzvf robustmq-v0.0.1-release.tar.gz
diff --git a/docs/zh/RobustMQ-MQTT/Overview.md b/docs/zh/RobustMQ-MQTT/Overview.md
index bd6ab9bab..a69ed4ec6 100644
--- a/docs/zh/RobustMQ-MQTT/Overview.md
+++ b/docs/zh/RobustMQ-MQTT/Overview.md
@@ -1,3 +1,4 @@
+# 概览
 RobustMQ MQTT是 RobustMQ 适配MQTT协议的完整实现。它支持：
 - 集群化部署，水平无感知扩容。
 - 单机可承载百万连接。


Test patch: