Closed
Description
背景 🧐
修复飞桨文档,是许多开发者参与飞桨开源活动的起点。通过修复飞桨文档并提交 PR的形式,你将熟悉为 Paddle 社区贡献代码的流程规范。
我们提供了文档(主要为API文档)相关的 Bug 清单,并以任务的形式发布。本任务十分简单,如果你刚接触飞桨,或者对文档活动怀有热情,欢迎认领该系列任务🥳。
文档 Bug 来源
「文档评测」:我们曾组织社区开发者对高频浏览的 API 文档进行评测,并发现了许多文档问题需要进行修复,详见:「文档修复」(来源于文档评测)✅已完成- 「 官网文档 Bug 确认 🔍 Paddle#55585 」:飞桨官网为用户提供了【文档反馈】的渠道,我们联同社区开发者整理了一份用户通过该渠道反馈的文档问题,详见: 「文档修复」(来源于bug确认赛)
你可以在以上 2 个来源中,选择任意数量的有问题的文档,进行认领并提交 PR 修复。
⚠️ 请优先修复来源于「bug确认赛」的问题。
⚠️ 有些问题可能已经在任务过程中被修复,可在此 issue 中 @sunzhongkai588 进行说明。
⚠️ 中文文档在 docs 仓库下修改,英文文档在 Paddle 仓库对应的 API 源码中修改。
任务流程 🚩
-
在上述提供的表格
中,「认领人」 一栏填写自己的 GitHub ID,同时在此 issue 中回复认领任务的
渠道+序号
,如文档评测-NO.1
、Bug确认赛-NO.1
。 -
修复完问题并提交 PR 时,请注意 PR 描述的规范
- PR 标题:
[Docathon] Fix xxxxx API Docs
- PR 内容:
<!-- Demo: https://github.com/PaddlePaddle/Paddle/pull/24810 --> ### PR types <!-- One of [ New features | Bug fixes | Function optimization | Performance optimization | Breaking changes | Others ] --> Bug fixes ### PR changes <!-- One of [ OPs | APIs | Docs | Others ] --> Docs ### Description <!-- Describe what you’ve done --> Issue from:「文档评测」NO.1 涉及到的 API 有: docs\api\paddle\io\DataLoader_cn.rst ... 关联文档(如有):https://github.com/PaddlePaddle/Paddle/pull/xxxxx 相关链接: https://github.com/PaddlePaddle/docs/issues/6187 https://github.com/PaddlePaddle/docs/issues/6165 @sunzhongkai588
- PR 标题:
-
提交 PR 后,请先自行浏览文档的预览链接,如果预览中有显示不正常的地方,则需要继续修复。
- 中文文档预览链接: http://preview-paddle-pr-XXXXX.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/en/api/paddle/abs_en.html
- 英文文文档预览链接: http://preview-paddle-pr-XXXXXX.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/abs_cn.html
⚠️ 其中XXXXX
为 PR 号。
⚠️ 文档预览链接需要等文档 CI 跑完之后才生效。中文文档 CI 为Doc-New
,英文文档 CI 为
PR-CI-Paddle-Doc-Preview
。
-
修复完成后,请在相应的表格中填写 PR 链接,方便后续统计。
mentor:@sunzhongkai588
参考链接 📖
- 文档贡献流程
- API文档书写规范(重要
‼️ ) - git操作入门与GitHub简介
参考PR:<待填>