Skip to content

Commit f8444de

Browse files
committed
docs: enhance the content and structure of the docs
1 parent 745be2b commit f8444de

File tree

26 files changed

+58
-338
lines changed

26 files changed

+58
-338
lines changed

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.2.x/Getting Started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 3
33
---
44

5-
# 安装
5+
# 安装指南
66

77
本文档介绍如何使用 `uv``pip` 安装和设置 ROCK 开发环境。该项目是一个强化学习开放构建工具包,支持多种组件。
88

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.2.x/Getting Started/quickstart.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,10 @@ sidebar_position: 2
66

77
本指南将通过完整的示例演示如何使用 ROCK 创建和管理强化学习环境。ROCK (Reinforcement Open Construction Kit) 是一个全面的沙箱环境管理框架,主要用于强化学习和AI开发环境。
88

9-
## 目录
10-
11-
- [快速上手](#快速上手)
12-
- [目录](#目录)
13-
- [1. 环境准备](#1-环境准备)
14-
- [1.1 系统要求](#11-系统要求)
15-
- [1.2 验证依赖安装](#12-验证依赖安装)
16-
- [1.3 项目初始化](#13-项目初始化)
17-
- [2. 激活虚拟环境](#2-激活虚拟环境)
18-
- [3. 验证环境配置](#3-验证环境配置)
19-
- [4. 启动 ROCK 服务](#4-启动-rock-服务)
20-
- [5. 运行示例环境](#5-运行示例环境)
21-
- [5.1 示例说明](#51-示例说明)
22-
- [6. 分布式环境配置(可选)](#6-分布式环境配置可选)
23-
- [7. MacOS 启动](#7-macos-启动)
24-
- [8. 从Pip源启动](#8-从pip源启动)
25-
- [总结](#总结)
26-
- [下一步学习](#下一步学习)
279

2810
## 1. 环境准备
2911

30-
我们推荐在 Linux 系统下启动 ROCK,能够尽量复用项目依赖,提升环境拉起速度。如果需要在 macOS 上尝试,可以参考 [MacOS 启动](#7-macos启动) 一节。
12+
我们推荐在 Linux 系统下启动 ROCK,能够尽量复用项目依赖,提升环境拉起速度。如果需要在 macOS 上尝试,可以参考 [MacOS 启动](#7-macos-启动) 一节。
3113

3214
在开始之前,请确保您的系统已安装以下依赖项:
3315

@@ -154,14 +136,14 @@ python examples/sokoban_demo.py
154136
export ROCK_WORKER_ENV_TYPE=uv
155137
```
156138

157-
在容器启动时,会安装对应的 uv 环境,细节可以参考 `rock/rocklet/docker_run_with_uv.sh` 脚本。
139+
在容器启动时,会安装对应的 uv 环境,细节可以参考 `rock/rocklet/local_files/docker_run_with_uv.sh` 脚本。
158140

159141
> **注意**: 相比 Linux 系统,macOS 上的启动速度会较慢,且比较依赖网络环境,可以根据实际情况调整脚本。ROCK_WORKER_ENV_TYPE的细节可以参考 [Configuration Guide](../User%20Guides/configuration.md).
160142
161143

162144
## 8. 从Pip源启动
163145

164-
如果从Pip源启动Admin Server,在参照[installation.md](./installation.md)安装完成ROCK后, 需要设置额外环境变量:
146+
如果从Pip源启动Admin Server,在参照[安装指南](./installation.md)安装完成ROCK后, 需要设置额外环境变量:
165147

166148
```bash
167149
export ROCK_WORKER_ENV_TYPE=pip

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.2.x/Getting Started/rockroll.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ bash examples/agentic_demo/run_agentic_pipeline_sokoban_sandbox_single_node.sh
105105

106106
为获得最佳兼容性,推荐使用 ROLL 官方提供的基础 Docker 镜像,因为它们已经预装了匹配的 CUDA、cuDNN 和其他基础库。
107107

108-
> [ROLL 官方镜像列表](https://alibaba.github.io/ROLL/docs/English/QuickStart/)
108+
> [ROLL 官方镜像列表](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/Installation/image_address/)
109109
110110

111111
#### 注意
@@ -142,7 +142,7 @@ bash examples/agentic_demo/run_agentic_pipeline_sokoban_sandbox_single_node.sh
142142

143143
### 3.1 在机器 A 上部署 ROCK 服务
144144

145-
在一台独立的机器(或容器)上,参照[ROCK快速指南](https://rock.io.alibaba-inc.com/docs/rock/CN/quickstart)部署并启动 ROCK 服务。
145+
在一台独立的机器(或容器)上,参照[ROCK快速指南](./quickstart.md)部署并启动 ROCK 服务。
146146

147147
> **重要提示**
148148
> 启动服务后,请记下ROCK服务的IP地址和端口,例如`http://192.168.1.10:8000`,后续步骤将需要这个地址。

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.2.x/References/Python SDK References/python_sdk.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,6 @@ sidebar_position: 2
66

77
本指南详细介绍如何使用 ROCK SDK 进行开发,包括沙箱环境管理和 GEM 环境交互。
88

9-
## 目录
10-
11-
- [Python SDK 参考](#python-sdk-参考)
12-
- [目录](#目录)
13-
- [1. 概述](#1-概述)
14-
- [2. Sandbox SDK](#2-sandbox-sdk)
15-
- [2.1 基本沙箱操作](#21-基本沙箱操作)
16-
- [3.2 沙箱组管理](#32-沙箱组管理)
17-
- [相关文档](#相关文档)
18-
- [3.3 配置示例](#33-配置示例)
19-
- [4. GEM SDK](#4-gem-sdk)
20-
- [4.1 Python SDK 方式](#41-python-sdk-方式)
21-
229
## 1. 概述
2310

2411
ROCK SDK为开发者提供了便捷的Python接口来使用ROCK平台的功能,包括沙箱环境管理和GEM环境交互。

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.2.x/References/api.md

Lines changed: 8 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,6 @@ sidebar_position: 1
66

77
本指南详细介绍 ROCK 平台提供的核心 API 服务,包括沙箱环境管理和 GEM 环境交互。
88

9-
## 目录
10-
11-
- [API 参考](#api-参考)
12-
- [目录](#目录)
13-
- [1. 概述](#1-概述)
14-
- [2. Sandbox API](#2-sandbox-api)
15-
- [沙箱管理接口](#沙箱管理接口)
16-
- [命令执行接口](#命令执行接口)
17-
- [文件操作接口](#文件操作接口)
18-
- [3. GEM API](#3-gem-api)
19-
- [相关文档](#相关文档)
20-
- [4. HTTP API 使用示例](#4-http-api-使用示例)
21-
- [4.1 Sandbox API 示例](#41-sandbox-api-示例)
22-
- [启动沙箱](#启动沙箱)
23-
- [异步启动沙箱](#异步启动沙箱)
24-
- [执行命令](#执行命令)
25-
- [创建会话](#创建会话)
26-
- [在会话中执行命令](#在会话中执行命令)
27-
- [上传文件](#上传文件)
28-
- [停止沙箱](#停止沙箱)
29-
- [4.2 GEM API 示例](#42-gem-api-示例)
30-
319
## 1. 概述
3210

3311
ROCK平台提供两种核心API服务:
@@ -106,14 +84,6 @@ GEM环境交互功能:
10684
4. **Close Environment** - 关闭GEM环境
10785
- 释放GEM环境资源
10886

109-
## 相关文档
110-
111-
- [快速开始指南](../Getting%20Started/quickstart.md) - 了解如何快速开始使用 ROCK API
112-
- [Python SDK 文档](./Python%20SDK%20References/python_sdk.md) - 学习如何使用 SDK 调用 API
113-
- [配置指南](../User%20Guides/configuration.md) - 了解 API 相关的配置选项
114-
- [安装指南](../Getting%20Started/installation.md) - 详细了解 ROCK 安装和配置
115-
116-
11787
## 4. HTTP API 使用示例
11888

11989
### 4.1 Sandbox API 示例
@@ -214,4 +184,11 @@ curl -X POST 'http://localhost:8080/apis/v1/envs/gem/step' \
214184
curl -X POST 'http://localhost:8080/apis/v1/envs/gem/close' \
215185
-H 'Content-Type: application/json' \
216186
-d '{"sandbox_id": "sandbox-12345"}'
217-
```
187+
```
188+
189+
## 相关文档
190+
191+
- [快速开始指南](../Getting%20Started/quickstart.md) - 了解如何快速开始使用 ROCK API
192+
- [Python SDK 文档](./Python%20SDK%20References/python_sdk.md) - 学习如何使用 SDK 调用 API
193+
- [配置指南](../User%20Guides/configuration.md) - 了解 API 相关的配置选项
194+
- [安装指南](../Getting%20Started/installation.md) - 详细了解 ROCK 安装和配置

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.2.x/User Guides/configuration.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,6 @@ sidebar_position: 4
66

77
本指南详细介绍如何配置 ROCK 环境以满足不同的使用需求,包括本地开发、测试和生产部署。
88

9-
## 目录
10-
11-
- [环境变量配置](#1-环境变量配置)
12-
- [运行时环境](#11-运行时环境)
13-
- [日志配置](#12-日志配置)
14-
- [分布式部署要求](#2-分布式部署要求)
15-
169
## 1. 环境变量配置
1710

1811
ROCK 支持通过环境变量配置关键参数。以下是主要的环境变量:

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.2.x/overview.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,6 @@ sidebar_position: 1
66

77
ROCK (Reinforcement Open Construction Kit) 是一个开源的强化学习环境开发框架,旨在简化强化学习环境的开发、部署和管理流程。
88

9-
## 目录
10-
11-
- [概览](#概览)
12-
- [目录](#目录)
13-
- [什么是 ROCK](#什么是-rock)
14-
- [ROCK 的核心功能](#rock-的核心功能)
15-
- [ROCK 的价值](#rock-的价值)
16-
- [了解更多](#了解更多)
17-
- [相关文档](#相关文档)
18-
199
## 什么是 ROCK
2010

2111
ROCK (Reinforcement Open Construction Kit) 是一个开源强化学习环境开发框架。通过使用 ROCK,开发者可以快速地开发强化学习环境,并结合其他强化学习训练框架,实现高效的强化学习训练。
@@ -35,14 +25,6 @@ ROCK 为不同角色的工程师提供了显著价值:
3525
- **强化学习算法工程师**:ROCK 可以简化强化学习环境的开发流程,让工程师专注于算法实现
3626
- **强化学习应用工程师**:ROCK 可以进行快速强化学习环境的大规模部署,提高应用开发效率
3727

38-
## 了解更多
39-
40-
- [快速开始指南](./Getting%20Started/quickstart.md) - 快速上手 ROCK
41-
- [配置指南](./User%20Guides/configuration.md) - 详细了解 ROCK 的配置选项
42-
- [API 文档](./References/api.md) - 查看 ROCK 提供的 API 接口
43-
- [Python SDK 文档](./References/Python%20SDK%20References/python_sdk.md) - 学习如何使用 ROCK 的 Python SDK
44-
- [安装指南](./Getting%20Started/installation.md) - 详细了解 ROCK 安装和配置
45-
4628
## 相关文档
4729

4830
如果您是第一次使用 ROCK,建议按以下顺序阅读文档:

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-1.0.x/Getting Started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 3
33
---
44

5-
# 安装
5+
# 安装指南
66

77
本文档介绍如何使用 `uv``pip` 安装和设置 ROCK 开发环境。该项目是一个强化学习开放构建工具包,支持多种组件。
88

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-1.0.x/Getting Started/quickstart.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,9 @@ sidebar_position: 2
66

77
本指南将通过完整的示例演示如何使用 ROCK 创建和管理强化学习环境。ROCK (Reinforcement Open Construction Kit) 是一个全面的沙箱环境管理框架,主要用于强化学习和AI开发环境。
88

9-
## 目录
10-
11-
- [快速上手](#快速上手)
12-
- [目录](#目录)
13-
- [1. 环境准备](#1-环境准备)
14-
- [1.1 系统要求](#11-系统要求)
15-
- [1.2 验证依赖安装](#12-验证依赖安装)
16-
- [1.3 项目初始化](#13-项目初始化)
17-
- [2. 激活虚拟环境](#2-激活虚拟环境)
18-
- [3. 验证环境配置](#3-验证环境配置)
19-
- [4. 启动 ROCK 服务](#4-启动-rock-服务)
20-
- [5. 运行示例环境](#5-运行示例环境)
21-
- [5.1 示例说明](#51-示例说明)
22-
- [6. 分布式环境配置(可选)](#6-分布式环境配置可选)
23-
- [7. MacOS 启动](#7-macos-启动)
24-
- [8. 从Pip源启动](#8-从pip源启动)
25-
- [总结](#总结)
26-
- [下一步学习](#下一步学习)
27-
289
## 1. 环境准备
2910

30-
我们推荐在 Linux 系统下启动 ROCK,能够尽量复用项目依赖,提升环境拉起速度。如果需要在 macOS 上尝试,可以参考 [MacOS 启动](#7-macos启动) 一节。
11+
我们推荐在 Linux 系统下启动 ROCK,能够尽量复用项目依赖,提升环境拉起速度。如果需要在 macOS 上尝试,可以参考 [MacOS 启动](#7-macos-启动) 一节。
3112

3213
在开始之前,请确保您的系统已安装以下依赖项:
3314

@@ -154,14 +135,14 @@ python examples/sokoban_demo.py
154135
export ROCK_WORKER_ENV_TYPE=uv
155136
```
156137

157-
在容器启动时,会安装对应的 uv 环境,细节可以参考 `rock/rocklet/docker_run_with_uv.sh` 脚本。
138+
在容器启动时,会安装对应的 uv 环境,细节可以参考 `rock/rocklet/local_files/docker_run_with_uv.sh` 脚本。
158139

159140
> **注意**: 相比 Linux 系统,macOS 上的启动速度会较慢,且比较依赖网络环境,可以根据实际情况调整脚本。ROCK_WORKER_ENV_TYPE的细节可以参考 [Configuration Guide](../User%20Guides/configuration.md).
160141
161142

162143
## 8. 从Pip源启动
163144

164-
如果从Pip源启动Admin Server,在参照[installation.md](./installation.md)安装完成ROCK后, 需要设置额外环境变量:
145+
如果从Pip源启动Admin Server,在参照[安装指南](./installation.md)安装完成ROCK后, 需要设置额外环境变量:
165146

166147
```bash
167148
export ROCK_WORKER_ENV_TYPE=pip

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-1.0.x/Getting Started/rockroll.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ bash examples/agentic_demo/run_agentic_pipeline_sokoban_sandbox_single_node.sh
105105

106106
为获得最佳兼容性,推荐使用 ROLL 官方提供的基础 Docker 镜像,因为它们已经预装了匹配的 CUDA、cuDNN 和其他基础库。
107107

108-
> [ROLL 官方镜像列表](https://alibaba.github.io/ROLL/docs/English/QuickStart/)
108+
> [ROLL 官方镜像列表](https://alibaba.github.io/ROLL/zh-Hans/docs/Getting%20Started/Installation/image_address/)
109109
110110

111111
#### 注意
@@ -142,7 +142,7 @@ bash examples/agentic_demo/run_agentic_pipeline_sokoban_sandbox_single_node.sh
142142

143143
### 3.1 在机器 A 上部署 ROCK 服务
144144

145-
在一台独立的机器(或容器)上,参照[ROCK快速指南](https://rock.io.alibaba-inc.com/docs/rock/CN/quickstart)部署并启动 ROCK 服务。
145+
在一台独立的机器(或容器)上,参照[ROCK快速指南](./quickstart.md)部署并启动 ROCK 服务。
146146

147147
> **重要提示**
148148
> 启动服务后,请记下ROCK服务的IP地址和端口,例如`http://192.168.1.10:8000`,后续步骤将需要这个地址。

0 commit comments

Comments
 (0)