Skip to content

docs: fix outdated APIs, config paths and broken links across docs#5145

Open
hoobnn wants to merge 9 commits into
PaddlePaddle:developfrom
hoobnn:docs/fix-doc-issues
Open

docs: fix outdated APIs, config paths and broken links across docs#5145
hoobnn wants to merge 9 commits into
PaddlePaddle:developfrom
hoobnn:docs/fix-doc-issues

Conversation

@hoobnn
Copy link
Copy Markdown
Contributor

@hoobnn hoobnn commented May 29, 2026

What

全量审核 docs/ 后修复的文档问题,共 179 条 code_api / link_image 类问题,每条均对照源码 grep / 文件存在性逐条核实(0 误报)。按模块组织为 9 个 commit,便于逐一审阅。

涵盖:

  • create_pipeline 形参 pipeline_namepipeline
  • 配置文件路径修正(补 /modules/ 层级、纠正目录/文件名)
  • Python/CLI 语法错误(全角逗号、缺逗号/括号/续行符/for 循环、列表后多余句点)
  • 源码中不存在或已废弃的参数(use_common_ocrhpi_paramsserial_number--update_licenseformat_jsonjson_format)
  • 废弃的扁平 Pipeline: YAML → 嵌套 SubModules: / SubPipelines:;PP-ChatOCRv3 旧版 API
  • 失效的相对链接与锚点(空目标、中文 slug、死链、错误目录)
  • 中英文一致性(从其它文档复制残留的模块名、bbox 描述、OCR serving 字段/endpoint 等)

绝大多数问题为英文文档滞后于已修正的中文文档。

Verification

code_api / link_image 类改动逐条对照 paddlex/ 源码 grep、配置路径 ls/test、以及中英文对应文件核实。

hoobnn and others added 9 commits May 29, 2026 23:28
…utorials

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…odule tutorials and instructions

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…line tutorials

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…utorials

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ne tutorials

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… tutorials

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ort list and misc pages

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@paddle-bot
Copy link
Copy Markdown

paddle-bot Bot commented May 29, 2026

Thanks for your contribution!

@paddle-bot paddle-bot Bot added the contributor External developers label May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor External developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant