Prhub

#41082 [Docs] Reorganize examples docs.

原始 PR 作者 noooop 合并时间 2026-05-08 14:23 文件变更 1 提交数 7 评论 1 代码增减 +14 / -4

执行摘要

重新组织 examples 文档目录结构

根据 RFC issue #29362 的建议,将 examples 按使用场景重新组织以提升用户查找效率。

建议合并,并确认所有链接指向的目录确实存在且内容相关。

讨论亮点

无相关讨论。

实现拆解

  1. 修改 docs/examples/README.md,将原先按“Offline Inference”、“Online Serving”、“Others”三类的描述替换为按场景分类的 13 个链接列表。
  2. 每个链接指向 examples/ 下的对应子目录,并附带简要说明。
文件 模块 状态 重要度
docs/examples/README.md 文档 modified 2.37

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

仅修改文档,无代码逻辑变更,风险极低。需确保目录链接正确,否则用户可能遇到死链。

影响范围仅限于文档读者的导航体验,无功能影响。

文档链接可能不准确

关联 Issue

#29362 [RFC]: Resettle examples.

完整报告

参与讨论