mmyolo icon indicating copy to clipboard operation
mmyolo copied to clipboard

[Docs] Fix Broken Internal Links in MMYOLO zh_CN/en Docs

Open OPlincn opened this issue 8 months ago • 2 comments

Motivation

While browsing and reviewing the MMYOLO documentation, I encountered some broken internal links that hindered readers from navigating the pages smoothly. Therefore, I have fixed these broken links and hope you will consider incorporating my changes.

Modification

Fixed the issue of broken links in the docs/en and zh_CN/recommended_topics/algorithm_descriptions/yolov8_description.md, which were supposed to navigate to the YOLOv5, YOLOv6, and RTMDet ALGORITHM PRINCIPLES AND IMPLEMENTATION documents.

Fixed the issue of broken links in the docs/en and zh_CN/recommended_topics/labeling_to_deployment_tutorials.md , specifically the MMYOLO installation guide link.

Fixed the issue of broken links in the docs/en and zh_CN/tutorials/config.md, particularly the link to the MMEngine Configuration File System.

Use cases (Optional)

image My modified documents can be successfully rendered, and the previously broken links now navigate correctly.

Checklist

  1. Pre-commit or other linting tools are used to fix potential lint issues. Yes✅
  2. The modification is covered by complete unit tests. If not, please add more unit tests to ensure the correctness. Yes✅
  3. If the modification has a potential influence on downstream projects, this PR should be tested with downstream projects, like MMDetection or MMClassification. Yes✅
  4. The documentation has been modified accordingly, like docstring or example tutorials. Yes✅

OPlincn avatar Jun 19 '24 07:06 OPlincn