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

Update social media links #12287

Merged
merged 2 commits into from
Oct 26, 2023
Merged

Update social media links #12287

merged 2 commits into from
Oct 26, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Oct 26, 2023

πŸ€– Generated by Copilot at 46430a5

Summary

πŸ“πŸŽ¨β™Ώ

This pull request enhances the documentation of the ultralytics/yolov5 repository by improving the readability and accessibility of the README.md and README.zh-CN.md files. It applies consistent formatting, spacing, and alt attributes to the text, tables, and icons in both files.

Sing, O Muse, of the skillful scribe who polished the README file
With careful breaks and spaces, and alt attributes for the blind
He made the text more clear and concise, pleasing to every eye
And matched his work in Chinese, with tables and icons aligned

Walkthrough

  • Remove unnecessary style attribute from social media icons in README.md and README.zh-CN.md (link, link)
  • Add line breaks after first sentences in various sections to improve readability and formatting in README.md and README.zh-CN.md (link, link, link, link, link, link, link, link, link)
  • Remove extra spaces in tables to improve alignment and formatting in README.md and README.zh-CN.md (link, link, link, link, link, link, link, link, link, link)
  • Add alt attribute to social media icons to improve accessibility and SEO in README.md and README.zh-CN.md (link, link)

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Refinement of social links and cleanup of README content in YOLOv5 repository.

πŸ“Š Key Changes

  • 🧹 Removed inline CSS for social links and opted for direct HTML image tags with alt text for better accessibility.
  • πŸ’¬ Updated alt text for social icons to include "Ultralytics" branding.
  • βœ‚οΈ Trimmed down redundant language and combined lines for a more concise README.
  • 🚚 Removal of a standalone section dedicated to YOLOv8.

🎯 Purpose & Impact

  • 🌐 Improves social link accessibility and streamlines user experience with more descriptive alt text.
  • ✨ Enhances the README's readability and navigability with a cleaner layout.
  • πŸ“„ Slight reduction in README length, leading to quicker load times and less scrolling.
  • πŸš€ Potentially improves the repo's appearance and user interface on platforms with different stylesheets or when viewed from code editors without CSS support.

@glenn-jocher glenn-jocher merged commit 53efd07 into master Oct 26, 2023
7 checks passed
@glenn-jocher glenn-jocher deleted the links branch October 26, 2023 17:28
pleb631 pushed a commit to pleb631/yolov5 that referenced this pull request Jan 6, 2024
* Update social media links

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

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

---------

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.

1 participant