Skip to content

docs: fix broken relative links in distillation and model list docs#18105

Open
evanclan wants to merge 1 commit into
PaddlePaddle:mainfrom
evanclan:docs/fix-relative-source-links
Open

docs: fix broken relative links in distillation and model list docs#18105
evanclan wants to merge 1 commit into
PaddlePaddle:mainfrom
evanclan:docs/fix-relative-source-links

Conversation

@evanclan

@evanclan evanclan commented Jun 4, 2026

Copy link
Copy Markdown

Summary

Fixes three relative markdown links that fail the repo link checker (reported in #18103). Each file already had a correct sibling link for the same target; this PR aligns the broken references with those paths.

Problem

From docs/version2.x/ppocr/model_compress/knowledge_distillation.{md,en.md}, the first distillation_model.py link used ../../ppocr/..., which resolves to docs/version2.x/ppocr/modeling/... (non-existent). The same pages link the file correctly later with ../../../../ppocr/modeling/architectures/distillation_model.py.

In docs/version2.x/ppocr/model_list.md, the ch_ppocr_mobile_v2.0_cls config link used ../../../../configs/cls/cls_mv3.yml (one ../ too many, resolving outside the repo). The slim variant on the preceding row already uses ../../../configs/cls/cls_mv3.yml.

Solution

  • knowledge_distillation.md / .en.md: change the early distillation_model.py link to ../../../../ppocr/modeling/architectures/distillation_model.py.
  • model_list.md: change the ch_ppocr_mobile_v2.0_cls config link to ../../../configs/cls/cls_mv3.yml.

Out of scope

  • External 404s (BOS model tarballs, PaddleSlim anchors, etc.) from the same link-check report.
  • Other ../../../../configs/... links under model_train/ subdirs — those paths are depth-correct for their directory.

Test plan

  • realpath from each doc directory confirms all three links resolve to ppocr/modeling/architectures/distillation_model.py and configs/cls/cls_mv3.yml.
  • CI link checker on the next scheduled run.

Related

Made with Cursor

The knowledge-distillation pages linked distillation_model.py with only
../../ (resolving under docs/version2.x/ppocr/) while the same doc's
later reference already used ../../../../. Align the early link with the
working path. model_list.md row for ch_ppocr_mobile_v2.0_cls used one
extra ../ so cls_mv3.yml resolved outside the repo; match the slim row.
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants