Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

OPlincn
Copy link

@OPlincn OPlincn commented Jun 19, 2024

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✅

@CLAassistant
Copy link

CLAassistant commented Jun 19, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

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.


OPlin seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants