aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/index.rst
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2024-03-10 06:42:58 +0800
committer简律纯 <i@jyunko.cn>2024-03-10 06:42:58 +0800
commite2c9fe71fd6133f9c97943cd6c7d664a73e94ab0 (patch)
tree27c1730e0d10ed0a0411c7b5bdd2957933e32a4d /docs/source/index.rst
parent93d2670039f7d68546a68eb0a917209b393b6527 (diff)
downloadHydroRoll-e2c9fe71fd6133f9c97943cd6c7d664a73e94ab0.tar.gz
HydroRoll-e2c9fe71fd6133f9c97943cd6c7d664a73e94ab0.zip
refactor(docs)!: setup docs toc tree
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst75
1 files changed, 56 insertions, 19 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index f7c2161..f1a41cc 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,32 +7,69 @@
.. toctree::
:hidden:
- :caption: 用户手册
+ :caption: 关于
-.. 第一步
-.. 使用脚手架
-.. 更多的配置
-.. webui 基础
-.. NIVIS 基本语法
-.. OneRoll 语法概览
-.. webui 进阶
-.. 最佳实践
+ 前言 <about/introduction.rst>
+ 基本特性 <about/list_of_features.rst>
+ 系统要求 <about/system_requirements.rst>
+ 常见问题 <about/faq.rst>
+ 遵循许可证 <about/complying_with_licenses/rst>
+ 水系发布策略 <about/release_policy.rst>
+ 变更日志 <about/changelog.rst>
.. .. toctree::
:hidden:
- :caption: 开发手册
+ :caption: 入门
-.. 成为脚本插件作者
-.. 成为规则包作者
-.. 成为模型作者
+ 前言 <getting_started/introduction/index.rst>
+ 渐进式教程 <getting_started/step_by_step/index.rst>
+ 你的第一个骰系 <getting_started/first_dice_system/index.rst>
+ 你的第一个脚本插件 <getting_started/first_script/index.rst>
+ 你的第一个规则书实现 <getting_started/first_rule_book_impl/index.rst>
+ 你的第一个智能语言模型 <getting_started/first_language_model/index.rst>
-.. API 文档
-.. 开发建议
.. toctree::
:hidden:
- :caption: Thanks and Credits
+ :caption: 手册
-.. 社区贡献指南
-.. 变更日志
-.. 协议 \ No newline at end of file
+ 最佳实践 <tutorials/best_practices/index.rst>
+ 故障排除 <tutorials/troubleshooting.rst>
+ 使用脚手架 <tutorials/use_cli.rst>
+ 迁移到新版本 <tutorials/migrating/index.rst>
+ 一切皆配置 <tutorials/all_in_configuration.rst>
+ WebUI 使用 <tutorials/webui/index.rst>
+ Nivis 语法指南 <tutorials/nivis_grammar/index.rst>
+ OneRoll 语法指南 <tutorials/oneroll_grammar/index.rst>
+ NLP 自然语言处理 <tutorials/nature_language_processing/index.rst>
+ ASR&TTS 音频处理 <tutorials/ast_and_tts/index.rst>
+ 性能比较与建议 <tutorials/performance/index.rst>
+ 平台相关 <tutorials/platform/index.rst>
+ 脚本插件 <tutorials/scripts/index.rst>
+ 跑团记录着色器 <tutorials/logshader/index.rst>
+
+
+.. toctree::
+ :hidden:
+ :caption: 贡献
+
+ 贡献方式 <contributing/ways_to_contribute.rst>
+ 贡献工作流 <contributing/workflow.rst>
+ 框架开发 <contributing/development/index.rst>
+ 编写文档 <contributing/documentation/index.rst>
+
+
+.. toctree::
+ :hidden:
+ :caption: 社区
+
+ 资产库 <community/asset_library/index.rst>
+ 社区渠道 <community/channels.rst>
+ 教程与资源 <community/tutorials.rst>
+
+
+.. toctree::
+ :hidden:
+ :caption: 开放 API 手册
+
+ 参考 <api/index.rst> \ No newline at end of file