Skip to content

Commit ea2b3e7

Browse files
committed
feat: auto generate userGuide in start and move start to parent folder
1 parent 4ab5a6e commit ea2b3e7

3 files changed

Lines changed: 45 additions & 33 deletions

File tree

docs_roll/docs/English/QuickStart/start.mdx renamed to docs_roll/docs/English/start.mdx

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import DocsFolerLink from '../../src/components/DocsFolderLink';
2+
13
<div align="center">
24

35
<img src="https://img.alicdn.com/imgextra/i2/O1CN01R6uYoU1VrrET7d1G6_!!6000000002707-0-tps-1292-407.jpg" width="40%" alt="ROLL Logo" />
@@ -33,6 +35,8 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource
3335

3436
---
3537

38+
39+
3640
## 🚀 Get Started
3741

3842
[Documents](https://alibaba.github.io/ROLL/)
@@ -50,39 +54,9 @@ Leveraging a multi-role distributed architecture with Ray for flexible resource
5054

5155
### UserGuide
5256

53-
#### Pipeline Step by Step
54-
[RLVR Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/rlvr_pipeline_start)
55-
[Agentic Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/agentic_pipeline_start)
56-
[Agentic Comprehensive Guide](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/agent_pipeline_start)
57-
[Distill Pipeline](https://alibaba.github.io/ROLL/docs/English/UserGuide/pipeline/distill_pipeline_start)
58-
59-
#### Algorithms
60-
[Reinforce++](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/Reinforce_Plus_Plus)
61-
[TOPR](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/TOPR)
62-
[GiGPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/agentic_GiGPO)
63-
[PPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/PPO)
64-
[Lite PPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/LitePPO)
65-
[GRPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/GRPO)
66-
[GSPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/GSPO)
67-
[RAFT++](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/RAFT_Plus_Plus)
68-
[StarPO](https://alibaba.github.io/ROLL/docs/English/UserGuide/algorithms/agentic_StarPO)
69-
70-
#### Backend
71-
[DeepSeed](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/deepspeed)
72-
[Megatron](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/megatron)
73-
[vLLM](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/vllm)
74-
[SGLang](https://alibaba.github.io/ROLL/docs/English/UserGuide/backend/sglang)
75-
76-
#### Advanced Features
77-
[Agentic Asynchronous Parallel Rollout](https://alibaba.github.io/ROLL/docs/English/UserGuide/agentic_async_parallel_rollout)
78-
[Agentic Asynchronous Training Feature](https://alibaba.github.io/ROLL/docs/English/UserGuide/async_training_agentic)
79-
80-
#### Performance Optimization & Resource Management
81-
[Resource Config](https://alibaba.github.io/ROLL/docs/English/UserGuide/device_mapping)
82-
[GPU Time-Division Multiplexing Control](https://alibaba.github.io/ROLL/docs/English/UserGuide/offload_reload_control)
83-
84-
-----
57+
<DocsFolerLink folder_label="UserGuide" />
8558

59+
---
8660
<div align="center">
8761
We welcome contributions from the community! 🤝
8862
</div>
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import React from 'react';
2+
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
3+
4+
function CategoryLink({ item, subLabel }) {
5+
if (item.type === 'link') {
6+
return <div><a href={item.href}>{item.label}</a></div>;
7+
}
8+
9+
if (item.type === 'category') {
10+
return (<div>
11+
{
12+
item.label !== subLabel &&
13+
<h4 style={{ marginTop: 8 }}>{item.label}</h4>
14+
}
15+
<div>
16+
{item.items.sort((a) => a.type === 'link' ? -1 : 1).map(subItem => <CategoryLink item={subItem} subLabel={subLabel} />)}
17+
</div>
18+
</div>)
19+
}
20+
21+
return <div>aa</div>
22+
}
23+
24+
function LinksOfFolder({ folder_label }) {
25+
const category = useCurrentSidebarCategory();
26+
27+
return (
28+
<div>
29+
{/* 这里不再显示这个标题,改为在start里展示,方便对应的页面展示出子导航 */}
30+
{/* <h3>{folder_label}</h3> */}
31+
{category.items.filter(item => item.label === folder_label).sort((a) => a.type === 'link' ? 1 : -1).map(item => <CategoryLink item={item} subLabel={folder_label} />)}
32+
</div>
33+
);
34+
}
35+
36+
37+
38+
export default LinksOfFolder;

docs_roll/src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export default function Home() {
3939

4040
const history = useHistory();
4141
useEffect(() => {
42-
history.replace('/ROLL/docs/English/QuickStart/start');
42+
history.replace('/ROLL/docs/English/start');
4343
}, [history]);
4444

4545
return (

0 commit comments

Comments
 (0)