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 update for new YOLOv5 URLs #11409

Merged
merged 12 commits into from
Apr 21, 2023
Merged

Docs update for new YOLOv5 URLs #11409

merged 12 commits into from
Apr 21, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Apr 21, 2023

πŸ€– Generated by Copilot at f466c45

Summary

πŸ“πŸŒπŸ€

This pull request updates the documentation links and messages in various files to align with the new documentation website for YOLOv5. It also removes a premature mention of YOLOv8 from the main README file. The changes aim to improve the clarity, consistency, and accessibility of the documentation for different users and languages.

The docs for YOLOv5 got a new site
With tutorials and guides to delight
The README.md files
Were updated with style
And the stale messages became more polite

Walkthrough

  • Remove YOLOv8 introduction from README files to avoid confusion (link, link, link)
  • Update links to tutorials, quickstart guides, and documentation website in README files and greetings workflow to reflect new structure and URLs (link, link, link, link, link, link)
  • Revise stale issue and PR messages to be more friendly and informative, and include links to additional resources and information (link)

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

This PR updates documentation links and introduces continuous checks for broken links across the repository.

πŸ“Š Key Changes

  • Updated the Quickstart Guides links in the greeting workflow for environments like Google Cloud and Docker. πŸ”—
  • Added a new GitHub Action workflow (links.yml) to check for and identify broken links automatically. πŸ”
  • Refreshed stale.yml to provide more resources in the message templates for stale issues and pull requests. ✨
  • Adjusted documentation links in README.md and its Chinese translation to point to updated tutorial pages. πŸ“˜
  • Updated the Comet logger README with the correct link to the YOLOv5 custom data training tutorial. 🌐

🎯 Purpose & Impact

  • Enhanced Documentation: The updates to the links ensure that users have accurate and current information, improving the overall user experience by directly connecting them to relevant guides and resources. πŸ“š
  • Automatic Link Validation: The new GitHub Action will prevent confusion and improve repository quality by ensuring all links are functional, thereby reducing the spread of outdated or incorrect information. πŸ› οΈ
  • Better Engagement with Stale Issues/PRs: The improved messaging for stale items on GitHub will encourage continued participation and provide additional help for those unfamiliar with other resources. πŸ—£οΈ

Users of the YOLOv5 project can expect to navigate more smoothly through the repository, with less likelihood of encountering broken links, while contributors have clear, up-to-date guidance and support.

@glenn-jocher glenn-jocher self-assigned this Apr 21, 2023
@glenn-jocher glenn-jocher merged commit fb1e746 into master Apr 21, 2023
@glenn-jocher glenn-jocher deleted the update_docs_tutorials branch April 21, 2023 11:50
bandakopi pushed a commit to irajcode/yolov5 that referenced this pull request Jul 20, 2023
* Update YOLOv5 Docs Tutorials

* Update YOLOv5 Docs Tutorials

* Update actions

* Update actions

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update actions

* Update actions

* Update actions

* Update actions

* Update actions

* Update actions

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.

None yet

1 participant