【紧急召集】Paddle主框架文档修复任务，速来！

[DrRyanHuang]

🎉 【Docathon 御剑令】《飞桨真经》残卷修复计划 | 急招文档修真者！ 🚀

（往期回顾：https://github.com/PaddlePaddle/docs/issues/6165）

🌟 秘境异动·代码示警

诸位道友，飞桨藏经阁突现时空裂隙！《Paddle 真经》遭遇三大危机：
🔸 混沌目录 - 章节如星斗错位，修士迷失方向（🌀）
🔸 异常代码 - API 说明暗藏隐患，运行时报错（😱）
🔸 文档缺失 - 核心接口缺少示例，开发者顿足捶胸（💥）

此局不解，恐误万千开发者修行！ 即刻御剑前来，共修优质文档大道！✨

---

🎯 修真任务·贡献指南

🔧 格式精修 清除代码异常

• Markdown 星轨校准 ✍️
• 注释规范化处理（中英混杂/格式混乱）🔮
• 失效案例修正（无法运行的代码示例）💻

🌐 结构优化 重构知识星图

• 章节乾坤挪移术 📜
• 交叉索引引路符 ➡️
• API 藏宝图优化 🗺️

💎 内容增强 完善文档内容

• 缺失心诀追魂术（补充代码示例）🔍
• 双语文档同步 🌍
• 图解大道真意（添加流程图/示意图）🎨

---

💡 Tips: 很多优秀的 Paddle 开发者都是从文档贡献开始的，这可能是你开启精彩开源之旅的第一步！

🧙‍♂️ 秘籍修复任务总览（持续更新 ing） 🔥

序号	内容链接	认领人/状态/PR 号
1	执行引擎 docs/api_guides/low_level/executor.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/executor.html
2	反向传播 docs/api_guides/low_level/backward.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/backward.html
3	CompiledProgram docs/api_guides/low_level/compiled_program.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/compiled_program.html
4	预测引擎 docs/api_guides/low_level/inference.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/inference.html
5	评价指标 docs/api_guides/low_level/metrics.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/metrics.html
6	模型保存与加载 docs/api_guides/low_level/model_save_reader.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/model_save_reader.html
7	复杂网络 docs/api_guides/low_level/nets.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/nets.html
8	优化器 docs/api_guides/low_level/optimizer.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/optimizer.html
9	模型参数 docs/api_guides/low_level/parameter.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/parameter.html
10	基础概念 docs/api_guides/low_level/program.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/program.html

🏹 参与方式

御剑登记：在下方高呼"本座愿往！" ✨ 请前往附录的任务认领部分查看
施展神通：fork → 修改 → PR 渡劫 💫

• 御剑飞行至秘籍藏经阁（Fork 飞桨 Docs GitHub 仓库🗝️
• 施展"分支大法"，创建你的修复空间 🌿（创建你的分支，可选）
• 运用"PR 秘技"，提交你的改动 ✨
  • 如果你是第一次修改，别担心，看这里：【Docathon】补充Overview文档相关API描述 docs#6427
• 提交 PR 后, 稍等片刻，待飞桨工程师 review 代码高呼"文档焕新，乾坤再造"，等待飞桨长老院审阅

📌 特别说明：⚠️ 本活动需要修改的文档，均为 develop 分支的内容。⚠️

---

🏆 贡献奖励

• 获得"文档守护者"神秘称号 👑
• 荣誉认证：永久记录于版本发行说明，你的大名将永载飞桨史册（Contributors 名单）📜
• 限定周边：开源社区专属纪念品，限量版开源周边法宝
• 进阶通道：核心贡献者快速通道资格 ，直通 Paddle 核心长老团试炼

🐉 勇士啊，别犹豫了！点击右上角的 Issue 按钮，开启你的文档修复冒险吧！

（悄悄告诉你：提交 PR 还能触发自动炼丹术，让你的修复更上一层楼哦~）🧪✨

💪 任务认领

Important

请务必严格按照格式填写，否则无法快乐开源小助手无法自动更新信息

1. Issue 回复格式：

为了自动填写报名信息，需要在 issue 下回复报名信息，如果报名格式不正确，则会在 comment 区提示报名不正确，格式如下：

【报名】: 2、3、6-10

📌 其中【报名】: 后直接是报名的赛题序号，多个赛题之间需要用中文顿号、分隔，多个连续赛题可以用横线表示

2. PR 标题格式：

[Docathon][Add Overview Doc No.2、3、6-10]+相关描述

PR 的标题中以 [Docathon][Update Doc No.xxxx] 开头即可，程序会自动提取赛题编号并更新榜单。
一个 PR 也可以提交多个赛题，多个赛题间以顿号或横线分隔，比如 No.24、26-28、30 赛题。

3. PR 内容：

描述新增了哪些 Overview 的 API 描述、附上中文文档链接、并 @DrRyanHuang 和 @sunzhongkai588

看板信息

任务方向	任务数量	提交作品 / 任务认领	提交率	完成	完成率
Docathon	10	0 / 10	0%	0	0%

[SigureMo]

docs/api_guides 目录是不是可以都删了？基本都是过时的 fluid API 介绍，而且都没有侧边栏，应该都没有其他文档引用 @sunzhongkai588

[sunzhongkai588]

docs/api_guides 目录是不是可以都删了？基本都是过时的 fluid API 介绍，而且都没有侧边栏，应该都没有其他文档引用 @sunzhongkai588

看了下，好像有些是被其他文章引用

• executor.rst （引用处）
• optimizer.rst （都是被 docs/api_guides 引用的）
• parameter.rst （引用处）
• program.rst （引用处）

感觉除了这几个，另外的全删了应该都没影响（英文也得删）