【快乐开源】PaddlePaddle 文档链接修复任务 -- 第一期 #7735
Description
一、任务背景
PaddlePaddle 文档仓库中存在大量失效链接,包括 API 文档、设计文档、指南文档等。这些失效链接影响了文档的可读性和用户体验,需要逐一排查并修复。本次任务旨在修复所有已发现的文档链接错误,提升文档质量。
文档链接失效的主要原因包括:
- 外部网站结构调整(如 NumPy、PyTorch、torchvision 等官方文档)
- PaddlePaddle 代码仓库重构导致源码路径变更
- 历史图片和资源迁移或删除
这是成为开源贡献者的绝佳机会,许多优秀开源贡献者的第一步都是从文档贡献开始的,欢迎大家积极参与! 🎉 如有任何问题,欢迎在 issue 中讨论。
二、任务清单
赛道一(任务 1-74)
| 序号 | 文档路径 | 链接数 | 任务描述 | 认领人/状态/PR号 |
|---|---|---|---|---|
| ⬇️ 贡献指南文档(1) | ||||
| 1 | CONTRIBUTING_cn.md |
1 | 更新贡献指南相关链接 | |
| ⬇️ Paddle API 文档(2-6) | ||||
| 2 | docs/api/paddle/slice_cn.rst |
1 | 更新 NumPy 索引文档链接 | |
| 3 | docs/api/paddle/strided_slice_cn.rst |
1 | 更新 NumPy 索引文档链接 | |
| 4 | docs/api/paddle/text/Conll05st_cn.rst |
1 | 更新 Conll05st 数据集链接 | |
| 5 | docs/api/paddle/text/Overview_cn.rst |
1 | 更新 PaddleNLP embeddings 文档链接 | |
| 6 | docs/api/paddle/text/UCIHousing_cn.rst |
1 | 更新 UCI Housing 数据集链接 | |
| ⬇️ API 指南文档(7) | ||||
| 7 | docs/api_guides/low_level/optimizer_en.rst |
1 | 更新反向传播算法维基百科链接 | |
| ⬇️ 设计文档-算法(8) | ||||
| 8 | docs/design/algorithm/parameter_average.md |
4 | 更新 rmsprop_op 源码链接(2处)、ASGD 和 theta_star 图片链接(2处) | |
| ⬇️ 设计文档-并发编程(9-10) | ||||
| 9 | docs/design/concurrent/concurrent_programming.md |
3 | 更新并发编程相关链接(Golang CSP、Go runtime、Goroutine) | |
| 10 | docs/design/concurrent/csp.md |
5 | 更新 CSP 理论链接(Tony Hoare 论文、Golang、Channel、Goroutine 等) | |
| ⬇️ 设计文档-数据类型(11) | ||||
| 11 | docs/design/data_type/float16.md |
4 | 更新 float16 相关链接(CUDA、ARM、Eigen、Numpy 文档) | |
| ⬇️ 设计文档-分布式训练(12-15) | ||||
| 12 | docs/design/dist_train/distributed_architecture.md |
6 | 更新分布式架构图片链接(6处架构图) | |
| 13 | docs/design/dist_train/mpi_enabled_design.md |
2 | 更新 MPI 相关链接(设计文档、架构图) | |
| 14 | docs/design/dist_train/multi_cpu.md |
2 | 更新多 CPU 训练相关链接 | |
| 15 | docs/design/dist_train/parameter_server.md |
3 | 更新参数服务器设计链接(架构图、相关文档) | |
| ⬇️ 设计文档-动态 RNN(16-17) | ||||
| 16 | docs/design/dynamic_rnn/rnn.md |
3 | 更新 RNN 相关链接(TensorFlow、PaddlePaddle 设计文档) | |
| 17 | docs/design/dynamic_rnn/rnn_design.md |
2 | 更新 RNN 设计文档链接 | |
| ⬇️ 设计文档-内存优化(18) | ||||
| 18 | docs/design/memory/memory_optimization.md |
3 | 更新内存优化相关链接(论文、设计图) | |
| ⬇️ 设计文档-MKL-DNN INT8(19-21) | ||||
| 19 | docs/design/mkldnn/int8/PTQ/README.md |
3 | 更新 PTQ(训练后量化)相关链接 | |
| 20 | docs/design/mkldnn/int8/QAT/README.md |
2 | 更新 QAT(量化感知训练)相关链接 | |
| 21 | docs/design/mkldnn/int8/README.md |
1 | 更新 INT8 量化概述链接 | |
| ⬇️ 设计文档-模块(22-24) | ||||
| 22 | docs/design/modules/batch_norm_op.md |
2 | 更新 Batch Normalization 论文和源码链接 | |
| 23 | docs/design/modules/optimizer.md |
1 | 更新优化器设计文档链接 | |
| 24 | docs/design/modules/regularization.md |
8 | 更新正则化相关链接(论文、API 文档、源码等 8 处) | |
| ⬇️ 设计文档-设计动机(25-26) | ||||
| 25 | docs/design/motivation/fluid.md |
1 | 更新 Fluid 设计动机文档链接 | |
| 26 | docs/design/motivation/refactorization.md |
2 | 更新重构设计相关链接 | |
| ⬇️ 设计文档-多设备(27) | ||||
| 27 | docs/design/multi_devices/operator_kernel_type.md |
1 | 更新算子内核类型设计链接 | |
| ⬇️ 设计文档-网络模型(28-29) | ||||
| 28 | docs/design/network/deep_speech_2.md |
2 | 更新 DeepSpeech2 论文和设计链接 | |
| 29 | docs/design/network/sequence_decoder.md |
1 | 更新序列解码器设计链接 | |
| ⬇️ 设计文档-其他(30-32) | ||||
| 30 | docs/design/others/gan_api.md |
2 | 更新 GAN API 设计链接 | |
| 31 | docs/design/others/graph_survey.md |
1 | 更新图计算调研文档链接 | |
| 32 | docs/design/others/parameters_in_cpp.md |
1 | 更新 C++ 参数设计链接 | |
| ⬇️ 设计文档-量化(33) | ||||
| 33 | docs/design/quantization/training_quantization_model_format.md |
1 | 更新训练量化模型格式文档链接 | |
| ⬇️ 开发指南-概述(34) | ||||
| 34 | docs/dev_guides/Overview_cn.md |
1 | 更新开发指南概述链接 | |
| ⬇️ 开发指南-AMP 精度(35) | ||||
| 35 | docs/dev_guides/amp_precision/amp_op_dev_guide_cn.md |
1 | 更新 AMP 算子开发指南链接 | |
| ⬇️ 开发指南-API 贡献(36-39) | ||||
| 36 | docs/dev_guides/api_contributing_guides/api_docs_guidelines_cn.md |
1 | 更新 API 文档规范链接 | |
| 37 | docs/dev_guides/api_contributing_guides/new_cpp_op_cn.md |
14 | 更新新增 C++ 算子指南链接(源码、文档、示例等 14 处) | |
| 38 | docs/dev_guides/api_contributing_guides/new_python_api_cn.md |
12 | 更新新增 Python API 指南链接(源码、文档、示例等 12 处) | |
| 39 | docs/dev_guides/api_contributing_guides/read_before_contributing_cn.md |
8 | 更新贡献前必读链接(指南、文档、工具等 8 处) | |
| ⬇️ 开发指南-代码贡献(40) | ||||
| 40 | docs/dev_guides/code_contributing_path_cn.md |
11 | 更新代码贡献路径指南链接(文档、工具、规范等 11 处) | |
| ⬇️ 开发指南-自定义设备(41-45) | ||||
| 41 | docs/dev_guides/custom_device_docs/custom_device_example_cn.md |
1 | 更新自定义设备示例(中文)链接 | |
| 42 | docs/dev_guides/custom_device_docs/custom_device_example_en.md |
1 | 更新自定义设备示例(英文)链接 | |
| 43 | docs/dev_guides/custom_device_docs/custom_device_overview_cn.md |
5 | 更新自定义设备概述链接(5处文档和示例) | |
| 44 | docs/dev_guides/custom_device_docs/custom_kernel_docs/kernel_declare_en.md |
1 | 更新自定义内核声明文档链接 | |
| 45 | docs/dev_guides/custom_device_docs/new_device_backend_overview_cn.md |
4 | 更新新设备后端概述链接(4处文档) | |
| ⬇️ 开发指南-文档贡献(46) | ||||
| 46 | docs/dev_guides/docs_contributing_guides_cn.md |
2 | 更新文档贡献指南链接 | |
| ⬇️ 开发指南-Git 指南(47-51) | ||||
| 47 | docs/dev_guides/git_guides/codestyle_check_guide_cn.md |
1 | 更新代码风格检查指南链接 | |
| 48 | docs/dev_guides/git_guides/local_dev_guide_cn.md |
5 | 更新本地开发指南(中文)链接(5处文档和工具) | |
| 49 | docs/dev_guides/git_guides/local_dev_guide_en.md |
3 | 更新本地开发指南(英文)链接(3处文档) | |
| 50 | docs/dev_guides/git_guides/submit_pr_guide_cn.md |
1 | 更新提交 PR 指南(中文)链接 | |
| 51 | docs/dev_guides/git_guides/submit_pr_guide_en.md |
2 | 更新提交 PR 指南(英文)链接 | |
| ⬇️ 开发指南-曙光平台(52-53) | ||||
| 52 | docs/dev_guides/sugon/compile_and_test_cn.md |
1 | 更新曙光平台编译测试指南链接 | |
| 53 | docs/dev_guides/sugon/paddle_c86_fix_guides_cn.md |
5 | 更新 Paddle C86 修复指南链接(5处文档和工具) | |
| ⬇️ 评估文档(54) | ||||
| 54 | docs/eval/evaluation_of_docs_system.md |
1 | 更新文档系统评估链接 | |
| ⬇️ FAQ 文档(55-56) | ||||
| 55 | docs/faq/index_cn.rst |
1 | 更新 FAQ 索引链接 | |
| 56 | docs/faq/install_cn.md |
3 | 更新安装 FAQ 链接(3处文档) | |
| ⬇️ 使用指南-分布式训练(57) | ||||
| 57 | docs/guides/06_distributed_training/group_sharded_parallel_cn.rst |
2 | 更新分组分片并行训练链接 | |
| ⬇️ 使用指南-社区贡献(58) | ||||
| 58 | docs/guides/10_contribution/community_contribution_cn.md |
1 | 更新社区贡献指南链接 | |
| ⬇️ 使用指南-高级功能(59-60) | ||||
| 59 | docs/guides/advanced/model_to_onnx_cn.md |
1 | 更新模型转 ONNX 指南链接 | |
| 60 | docs/guides/advanced/visualdl_usage_en.md |
9 | 更新 VisualDL 使用指南链接(9处文档和示例) | |
| ⬇️ 使用指南-入门教程(61-62) | ||||
| 61 | docs/guides/beginner/tensor_cn.md |
37 | 更新张量教程(中文)链接(37处 API 文档和示例) | |
| 62 | docs/guides/beginner/tensor_en.md |
1 | 更新张量教程(英文)链接 | |
| ⬇️ 使用指南-CINN(63) | ||||
| 63 | docs/guides/cinn/paddle2cinn_intro_cn.md |
5 | 更新 Paddle2CINN 介绍链接(5处文档) | |
| ⬇️ 使用指南-自定义算子(64) | ||||
| 64 | docs/guides/custom_op/new_cpp_op_cn.md |
2 | 更新自定义 C++ 算子指南链接 | |
| ⬇️ 使用指南-环境变量(65-66) | ||||
| 65 | docs/guides/flags/executor_cn.rst |
1 | 更新执行器环境变量(中文)链接 | |
| 66 | docs/guides/flags/executor_en.rst |
1 | 更新执行器环境变量(英文)链接 | |
| ⬇️ 使用指南-推理(67-69) | ||||
| 67 | docs/guides/infer/mobile/mobile_index_cn.md |
1 | 更新移动端推理索引链接 | |
| 68 | docs/guides/infer/paddleslim/paddle_slim_cn.md |
1 | 更新 PaddleSlim 压缩工具(中文)链接 | |
| 69 | docs/guides/infer/paddleslim/paddle_slim_en.rst |
5 | 更新 PaddleSlim 压缩工具(英文)链接(5处文档) | |
| ⬇️ 使用指南-JIT(70-74) | ||||
| 70 | docs/guides/jit/basic_usage_en.md |
2 | 更新 JIT 基础用法(英文)链接 | |
| 71 | docs/guides/jit/case_analysis_cn.md |
4 | 更新 JIT 案例分析(中文)链接(4处文档) | |
| 72 | docs/guides/jit/debugging_cn.md |
6 | 更新 JIT 调试指南(中文)链接(6处文档) | |
| 73 | docs/guides/jit/debugging_en.md |
6 | 更新 JIT 调试指南(英文)链接(6处文档) | |
| 74 | docs/guides/jit/grammar_list_cn.md |
2 | 更新 JIT 语法列表(中文)链接 |
三、如何开始
⚠️ 全流程梳理 ⚠️
1.任务认领 （附要求）-->2.克隆仓库 -->3.配置环境 -->4.进行修复（附修复方法） --> 5.提交PR（附PR提交模板） -->6.等待跑通反馈
1. 任务认领
Important
请务必严格按照格式填写,否则快乐开源小助手无法自动更新信息
请大家在 issue 下以 comment 的形式认领任务,格式如下:
【报名】: 1、2、3-5
多个任务之间使用中文顿号分隔,多个连续任务可用横线表示
2. 克隆仓库
git clone https://github.com/PaddlePaddle/docs.git
cd docs3. 配置环境
本任务无需特殊环境配置,使用文本编辑器(如 VS Code)即可完成。
4. 进行修复
4.1 外部文档链接修复
对于 NumPy、PyTorch、torchvision 等外部文档:
- 访问官方最新文档网站
- 搜索对应的 API 或功能
- 复制正确的 URL 地址
- 替换文档中的失效链接
4.2 源码链接修复
对于 PaddlePaddle 源码链接:
- 在 Paddle 代码仓库中搜索对应的文件名或函数名
- 确认文件当前的正确路径
- 更新文档中的链接为新路径
Tip
源码修复需要向 Paddle 主库提交 PR,请参考贡献指南
4.3 图片链接修复
对于失效的图片链接:
- 在文档仓库历史版本中查找图片
- 使用 Web Archive 查找历史快照
- 如找不到原图,可考虑重新绘制或寻找替代图片
- 将图片上传到合适的位置并更新链接
5. 提交 PR
PR 标题格式
[Doc Link Fix No.xxx] 文档链接修复
示例: [Doc Link Fix No.1-5] paddle API 文档链接修复
PR 内容模板
## 修复内容
### 任务 1: docs/api/paddle/slice_cn.rst
- 原链接: https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html
- 新链接: https://numpy.org/doc/stable/user/basics.indexing.html
- 修复原因: NumPy 官方文档结构调整
## 验证结果
已手动访问所有更新后的链接,确认所有链接可正常访问
- https://github.com/PaddlePaddle/docs/issues/7735
@Echo-Nie
四、PR 示例
看板信息
统计信息
Metadata
Metadata
Labels
Type
Projects
Status