Skip to content

Commit 9336352

Browse files
committed
Flatten docs sidebar into chapter-numbered toctrees
Replace the three nested toctrees in each language index with two flat ones — Manual (Chapter 1 — Getting Started ... Chapter 15 — Plugins) and API Reference (Chapter A — Core ... Chapter L — Utils). Removes the redundant usage/index and api/index wrapper pages so each chapter is a top-level sidebar entry.
1 parent 9267a51 commit 9336352

9 files changed

Lines changed: 89 additions & 216 deletions

File tree

docs/source.zh-CN/api/index.rst

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

docs/source.zh-CN/index.rst

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -159,21 +159,40 @@ JSON 动作列表就是上述 list 的 list。
159159

160160
.. toctree::
161161
:maxdepth: 2
162-
:caption: 架构
163-
164-
architecture
165-
166-
.. toctree::
167-
:maxdepth: 3
168-
:caption: 使用指南
169-
170-
usage/index
162+
:caption: 手册
163+
164+
第 1 章 — 入门 <usage/quickstart>
165+
第 2 章 — CLI <usage/cli>
166+
第 3 章 — 架构 <architecture>
167+
第 4 章 — 本地操作 <usage/local>
168+
第 5 章 — HTTP 传输 <usage/transfer>
169+
第 6 章 — 云端与 SFTP 后端 <usage/cloud>
170+
第 7 章 — 动作服务器 <usage/servers>
171+
第 8 章 — MCP 服务器 <usage/mcp>
172+
第 9 章 — 图形界面 <usage/gui>
173+
第 10 章 — 可靠性 <usage/reliability>
174+
第 11 章 — 触发器与调度 <usage/events>
175+
第 12 章 — 通知 <usage/notifications>
176+
第 13 章 — 配置与机密信息 <usage/config>
177+
第 14 章 — DAG 动作执行器 <usage/dag>
178+
第 15 章 — 插件 <usage/plugins>
171179

172180
.. toctree::
173181
:maxdepth: 2
174182
:caption: API 参考
175183

176-
api/index
184+
第 A 章 — 核心 <api/core>
185+
第 B 章 — 本地操作 <api/local>
186+
第 C 章 — 远端操作 <api/remote>
187+
第 D 章 — 服务器 <api/server>
188+
第 E 章 — 客户端 SDK <api/client>
189+
第 F 章 — 触发器 <api/trigger>
190+
第 G 章 — 调度器 <api/scheduler>
191+
第 H 章 — 通知 <api/notify>
192+
第 I 章 — 进度与取消 <api/progress>
193+
第 J 章 — 项目脚手架 <api/project>
194+
第 K 章 — 图形界面 <api/ui>
195+
第 L 章 — 工具 <api/utils>
177196

178197
索引
179198
----

docs/source.zh-CN/usage/index.rst

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

docs/source.zh-TW/api/index.rst

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

docs/source.zh-TW/index.rst

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -159,21 +159,40 @@ JSON 動作清單就是上述 list 的 list。
159159

160160
.. toctree::
161161
:maxdepth: 2
162-
:caption: 架構
163-
164-
architecture
165-
166-
.. toctree::
167-
:maxdepth: 3
168-
:caption: 使用指南
169-
170-
usage/index
162+
:caption: 手冊
163+
164+
第 1 章 — 入門 <usage/quickstart>
165+
第 2 章 — CLI <usage/cli>
166+
第 3 章 — 架構 <architecture>
167+
第 4 章 — 本地操作 <usage/local>
168+
第 5 章 — HTTP 傳輸 <usage/transfer>
169+
第 6 章 — 雲端與 SFTP 後端 <usage/cloud>
170+
第 7 章 — 動作伺服器 <usage/servers>
171+
第 8 章 — MCP 伺服器 <usage/mcp>
172+
第 9 章 — 圖形介面 <usage/gui>
173+
第 10 章 — 可靠性 <usage/reliability>
174+
第 11 章 — 觸發器與排程 <usage/events>
175+
第 12 章 — 通知 <usage/notifications>
176+
第 13 章 — 設定與機敏資訊 <usage/config>
177+
第 14 章 — DAG 動作執行器 <usage/dag>
178+
第 15 章 — 外掛 <usage/plugins>
171179

172180
.. toctree::
173181
:maxdepth: 2
174182
:caption: API 參考
175183

176-
api/index
184+
第 A 章 — 核心 <api/core>
185+
第 B 章 — 本地操作 <api/local>
186+
第 C 章 — 遠端操作 <api/remote>
187+
第 D 章 — 伺服器 <api/server>
188+
第 E 章 — 客戶端 SDK <api/client>
189+
第 F 章 — 觸發器 <api/trigger>
190+
第 G 章 — 排程器 <api/scheduler>
191+
第 H 章 — 通知 <api/notify>
192+
第 I 章 — 進度與取消 <api/progress>
193+
第 J 章 — 專案腳手架 <api/project>
194+
第 K 章 — 圖形介面 <api/ui>
195+
第 L 章 — 工具 <api/utils>
177196

178197
索引
179198
----

docs/source.zh-TW/usage/index.rst

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

docs/source/api/index.rst

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

docs/source/index.rst

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -162,21 +162,40 @@ A JSON action list is simply a list of these lists.
162162

163163
.. toctree::
164164
:maxdepth: 2
165-
:caption: Architecture
166-
167-
architecture
168-
169-
.. toctree::
170-
:maxdepth: 3
171-
:caption: Usage guide
172-
173-
usage/index
165+
:caption: Manual
166+
167+
Chapter 1 — Getting Started <usage/quickstart>
168+
Chapter 2 — CLI <usage/cli>
169+
Chapter 3 — Architecture <architecture>
170+
Chapter 4 — Local Operations <usage/local>
171+
Chapter 5 — HTTP Transfers <usage/transfer>
172+
Chapter 6 — Cloud and SFTP Backends <usage/cloud>
173+
Chapter 7 — Action Servers <usage/servers>
174+
Chapter 8 — MCP Server <usage/mcp>
175+
Chapter 9 — GUI <usage/gui>
176+
Chapter 10 — Reliability <usage/reliability>
177+
Chapter 11 — Triggers and Scheduler <usage/events>
178+
Chapter 12 — Notifications <usage/notifications>
179+
Chapter 13 — Configuration and Secrets <usage/config>
180+
Chapter 14 — DAG Action Executor <usage/dag>
181+
Chapter 15 — Plugins <usage/plugins>
174182

175183
.. toctree::
176184
:maxdepth: 2
177-
:caption: API reference
178-
179-
api/index
185+
:caption: API Reference
186+
187+
Chapter A — Core <api/core>
188+
Chapter B — Local Operations <api/local>
189+
Chapter C — Remote Operations <api/remote>
190+
Chapter D — Server <api/server>
191+
Chapter E — Client SDK <api/client>
192+
Chapter F — Triggers <api/trigger>
193+
Chapter G — Scheduler <api/scheduler>
194+
Chapter H — Notifications <api/notify>
195+
Chapter I — Progress and Cancellation <api/progress>
196+
Chapter J — Project Scaffolding <api/project>
197+
Chapter K — Graphical User Interface <api/ui>
198+
Chapter L — Utils <api/utils>
180199

181200
Indices
182201
-------

docs/source/usage/index.rst

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

0 commit comments

Comments
 (0)