Skip to content

文档侧边栏草案

本文件是这套指南的“人类可读版侧边栏”。 如果后续要接入 Docusaurus、VitePress、MkDocs 或其他文档站点,可以先按这份结构组织页面分组,再把同样结构映射到程序化配置中。

对应的机器可读配置见:docs/site-navigation.json

1. 首页与总览

2. 主线篇(12 章)

模块 1:做出能跑的单智能体

模块 2:做出可用的智能体系统

模块 3:做出可上线的工程体系

模块 4:做出可投递的求职闭环

3. 执行模板与周示例

4. 专题篇(12 个)

5. 项目篇(4 条)

6. 示例篇

文档示例

证据与素材

  • docs/examples/assets/README.md
  • docs/examples/assets/samples/README.md
  • docs/examples/assets/screenshots/README.md

可运行骨架

  • examples/README.md
  • examples/run.py
  • examples/showcase/README.md

7. 附录篇(7 份)

8. 侧边栏使用建议

  • 如果要做“阅读型文档站”,建议默认展开“首页与总览”“主线篇”,其他分组默认折叠。
  • 如果要做“课程型文档站”,建议把“主线篇”“专题篇”“项目篇”放在第一层,把“示例篇”“附录篇”放在第二层。
  • 如果要做“投递型作品集站”,建议优先展示“项目篇”“附录篇”“示例篇”,弱化周计划示例。