Skip to content

Improve assets README usage guidance#68

Merged
glenn-jocher merged 8 commits intomainfrom
rknn
Apr 23, 2026
Merged

Improve assets README usage guidance#68
glenn-jocher merged 8 commits intomainfrom
rknn

Conversation

@Burhan-Q
Copy link
Copy Markdown
Contributor

@Burhan-Q Burhan-Q commented Aug 14, 2024

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

This PR improves the ultralytics/assets README by clarifying how to link to assets directly and by documenting the repository’s folder structure for easier navigation 📘✨

📊 Key Changes

  • Added guidance to use raw GitHub URLs for stable asset links in documentation, notebooks, websites, and examples 🔗
  • Included a concrete example showing the direct raw URL for the Ultralytics logo 🖼️
  • Added a new Repository Layout section that explains the purpose of key folders like logo/, social/, docs/, im/, app/, and YOLO-related asset directories 📂
  • Expanded README documentation without changing any actual asset files or dataset contents 📝

🎯 Purpose & Impact

  • Makes it easier for users to find and reuse assets correctly across projects, presentations, and documentation ✅
  • Helps maintain more reliable links by pointing users to raw GitHub URLs instead of less stable browsing links 🌐
  • Improves onboarding for new contributors and users by giving a clearer overview of what each folder contains 🚀
  • Reduces confusion when searching for logos, images, screenshots, and YOLO-related visuals, saving time for both technical and non-technical users ⏱️

@Burhan-Q Burhan-Q added the enhancement New feature or request label Aug 14, 2024
@glenn-jocher glenn-jocher deleted the rknn branch April 23, 2026 22:12
@glenn-jocher glenn-jocher reopened this Apr 23, 2026
@glenn-jocher glenn-jocher changed the title Adds RKNN wheels and checksums Improve assets README usage guidance Apr 23, 2026
@glenn-jocher glenn-jocher marked this pull request as ready for review April 23, 2026 22:17
Copy link
Copy Markdown
Member

@glenn-jocher glenn-jocher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Burhan-Q. I rescued this PR by removing the RKNN wheel/checksum additions and keeping the final diff focused on README improvements: raw asset URL guidance plus a concise repository layout.\n\nValidated:\n- final PR diff is README.md only\n- git diff --check\n- Ultralytics Actions passed

@glenn-jocher glenn-jocher merged commit baf4e0d into main Apr 23, 2026
1 check passed
@UltralyticsAssistant
Copy link
Copy Markdown
Member

Merged — fantastic improvement to the ultralytics/assets README 🎉

As Leonardo da Vinci said, “Simplicity is the ultimate sophistication.” This update reflects that perfectly by making asset linking clearer, navigation easier, and the repository more approachable for everyone.

Big thanks to @Burhan-Q for the thoughtful documentation enhancements, and to @glenn-jocher for contributing to the effort. The added guidance on raw GitHub URLs and the new repository layout will make asset discovery and reuse much smoother for the community.

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants