Skip to content

Commit db3029c

Browse files
committed
docs: add v0.2.0 and v0.2.1 release note & auto sort release note by versions
1 parent ed172b8 commit db3029c

File tree

9 files changed

+107
-28
lines changed

9 files changed

+107
-28
lines changed

docs/docusaurus.config.js

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,47 @@ function hiddenTargetSidebars(items) {
1818
});
1919
return result;
2020
}
21+
const reverseReleaseNoteSidebars = (items) => {
22+
// 筛选出符合 Release Notes 格式的项
23+
const releaseNoteItems = items.filter(item => item.type !== 'category').filter(item => {
24+
const ids = item.id?.split('/');
25+
// 检查是否包含'Release Notes'且至少有2个部分
26+
if (ids.includes('Release Notes') && ids.length >= 2) {
27+
// 检查最后一个部分是否符合版本号格式(x.x.x 或 x.x.x.x)
28+
const versionPattern = /^v?\d+\.\d+\.\d+(\.\d+)?$/;
29+
return versionPattern.test(ids[ids.length - 1]);
30+
}
31+
return false;
32+
});
33+
34+
// 对符合条件的Release Notes条目进行排序
35+
if (releaseNoteItems.length > 0) {
36+
// 按版本号从大到小排序
37+
releaseNoteItems.sort((a, b) => {
38+
const versionA = a.id.split('/').pop();
39+
const versionB = b.id.split('/').pop();
40+
41+
// 将版本号分割为数字数组
42+
const partsA = versionA.replace(/^v/, '').split('.').map(Number);
43+
const partsB = versionB.replace(/^v/, '').split('.').map(Number);
44+
45+
// 逐个比较版本号的每个部分
46+
for (let i = 0; i < Math.max(partsA.length, partsB.length); i++) {
47+
const partA = partsA[i] || 0;
48+
const partB = partsB[i] || 0;
49+
50+
if (partA > partB) return -1;
51+
if (partA < partB) return 1;
52+
}
53+
54+
return 0;
55+
});
56+
}
57+
58+
// 合并非Release Notes项目和已排序的Release Notes项目
59+
const nonReleaseNoteItems = items.filter(item => !releaseNoteItems.includes(item));
60+
return [...nonReleaseNoteItems, ...releaseNoteItems];
61+
}
2162
// 如果需要在sidebar隐藏的话,可以把文档id加到这里,id的命名方式为 路径名/文件名
2263
const HiddenSidebars = ['Getting Started/quickstart', 'References/Python SDK References/python_sdk', 'Release Notes/index']
2364

@@ -71,7 +112,10 @@ const config = {
71112
showLastUpdateTime: true,
72113
sidebarItemsGenerator: async ({ defaultSidebarItemsGenerator, ...args }) => {
73114
const sidebarItems = await defaultSidebarItemsGenerator(args);
74-
return hiddenTargetSidebars(sidebarItems);
115+
// 去掉需要隐藏的侧边导航
116+
const filterHiddenSidebars = hiddenTargetSidebars(sidebarItems);
117+
// release note按照版本号倒排
118+
return reverseReleaseNoteSidebars(filterHiddenSidebars);
75119
},
76120
},
77121
theme: {

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/Release Notes/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
sidebar_position: 1
33
---
44
# 版本说明
5-
* [release v0.1.7.3](v0.1.7.3.md)
5+
* [release v0.2.1](v0.2.1.md)
6+
* [release v0.2.0](v0.2.0.md)

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/Release Notes/v0.1.7.3.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# v0.2.0
2+
3+
## 发布日期
4+
2025年11月8日
5+
6+
## 概述
7+
ROCK v0.2.0 是 ROCK (Reinforcement Open Construction Kit,强化学习开放构建工具包) 的首次正式发布版本。ROCK 是一个专为强化学习和AI开发环境设计的综合性沙箱环境管理框架。它提供了构建、运行和管理隔离容器化环境的工具,适用于开发、测试和研究场景。
8+
9+
ROCK 采用客户端-服务器架构,使用 Docker 进行容器化,并与现代开发工作流无缝集成。ROCK 不仅支持传统的沙箱管理功能,还符合 GEM 协议,为强化学习环境提供标准化接口。
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# v0.2.1
2+
3+
## 发布日期
4+
2025年11月10日
5+
6+
## 概述
7+
本次版本主要聚焦于系统优化和功能增强,包括代码清理、验证改进、内部结构优化和日志增强,以提升系统稳定性和可维护性。
8+
9+
## SDK
10+
11+
### 废弃
12+
- 删除无用的 `download_files` 方法
13+
14+
### 新增
15+
* 增加 DockerValidator 能力,校验必要的启动镜像
16+
17+
### 功能优化
18+
* 优化 ROCK 内部 Request/Response 结构
19+
* 优化了系统的日志
20+
* 调整了SDK内部方法名称

docs/rock/Release Notes/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
sidebar_position: 1
33
---
44
# Release Notes
5-
* [release v0.1.7.3](v0.1.7.3.md)
5+
* [release v0.2.1](v0.2.1.md)
6+
* [release v0.2.0](v0.2.0.md)

docs/rock/Release Notes/v0.1.7.3.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/rock/Release Notes/v0.2.0.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# v0.2.0
2+
3+
## Release Date
4+
November 8, 2025
5+
6+
## Overview
7+
Fisrt time Release RL ROCK, ROCK (Reinforcement Open Construction Kit) is a comprehensive sandbox environment management framework, primarily for reinforcement learning and AI development environments. It provides tools for building, running, and managing isolated containerized environments, suitable for development, testing, and research scenarios.
8+
9+
ROCK adopts a client-server architecture, uses Docker for containerization, and seamlessly integrates with modern development workflows. ROCK not only supports traditional sandbox management functions but also complies with the GEM protocol, providing standardized interfaces for reinforcement learning environments.

docs/rock/Release Notes/v0.2.1.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# v0.2.1
2+
3+
## Release Date
4+
November 10, 2025
5+
6+
## Overview
7+
This release focuses on system optimization and enhancement, including code cleanup, validation improvements, internal structure optimization, and logging enhancements to improve system stability and maintainability.
8+
9+
## SDK
10+
11+
### Deprecations
12+
- Removed unused `download_files` method
13+
14+
### New Features
15+
* Added DockerValidator capability to validate required startup images
16+
17+
### Enhancements
18+
* Optimized ROCK internal Request/Response structure
19+
* Optimized system logging
20+
* Adjusted SDK internal method names

0 commit comments

Comments
 (0)