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 index.md #168

Merged
merged 1 commit into from
Feb 22, 2025
Merged

Update index.md #168

merged 1 commit into from
Feb 22, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Feb 22, 2025

๐Ÿ› ๏ธ PR Summary

Made with โค๏ธ by Ultralytics Actions

๐ŸŒŸ Summary

This PR refactors the model comparison documentation by simplifying URL references for improved readability and maintenance.

๐Ÿ“Š Key Changes

  • Removed the compare/ prefix from links in the model comparison pages (e.g., compare/yolo11-vs-yolov10.md โžก๏ธ yolo11-vs-yolov10.md).
  • Updated links across all comparison files to reflect this change.

๐ŸŽฏ Purpose & Impact

  • โœ… Improved Maintainability: Streamlines the documentation structure, making future edits and link updates simpler.
  • ๐ŸŒŸ User Experience: Cleaner and more user-friendly links for easier navigation.
  • ๐Ÿ“š Consistency: Keeps the file paths concise and uniform across documentation.

This update ensures a smoother user experience when exploring model comparisons! ๐Ÿš€

Signed-off-by: Glenn Jocher <[email protected]>
Copy link

vercel bot commented Feb 22, 2025

The latest updates on your projects. Learn more about Vercel for Git โ†—๏ธŽ

Name Status Preview Comments Updated (UTC)
docs โœ… Ready (Inspect) Visit Preview ๐Ÿ’ฌ Add feedback Feb 22, 2025 0:36am

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Feb 22, 2025
@UltralyticsAssistant
Copy link
Member

๐Ÿ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/docs ๐Ÿš€ PR! To ensure a smooth review process and eventual integration of your work, please take a moment to verify the following checklist:

  • โœ… Explain the Purpose: Clearly outline the purpose of your change in the PR description. Link any related issues or discussions to provide context and reasoning.
  • โœ… Keep Your Branch Updated: Make sure your branch is up-to-date with the latest main branch of the ultralytics/docs repository. If it is not, you can click on the โ€˜Update branchโ€™ button or pull the latest changes locally using git pull and merge them into your branch.
  • โœ… Pass CI Checks: Ensure all Ultralytics Continuous Integration (CI) checks are passing. Address any build or test failures to maintain the repository's integrity.
  • โœ… Update Documentation Appropriately: Since this is a documentation repository, confirm that your changes align with the style and structure of the existing docs. If you've updated file paths or references (as seen in your PR description and diff), confirm the URLs or links are working properly.
  • โœ… Test Thoroughly: For any related codebase updates or link modifications, verify their correctness manually or via automated tests to prevent broken references in the docs.
  • โœ… Sign the CLA: If this is your first contribution to Ultralytics, please sign our Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA." This is a mandatory requirement for external contributors.
  • โœ… Restrict Changes: Focus your PR to the scope of the described changes (like fixing file paths and improving consistency in your case) and ensure there are no unrelated modifications. โœจ

For more details about contributing to Ultralytics, please refer to the Contributing Guide.

Thank you again for your contribution โ€” your efforts in improving the documentation are greatly appreciated! ๐Ÿš€ An Ultralytics engineer will review your PR as soon as possible. If you have any additional questions or need support, feel free to leave a comment. ๐Ÿ˜Š

@glenn-jocher glenn-jocher merged commit 8b99686 into main Feb 22, 2025
4 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch February 22, 2025 12:37
@UltralyticsAssistant
Copy link
Member

โœจ Merged! Huge thanks, @glenn-jocher, for this stellar contribution!

This thoughtful refactor reminds me of Leonardo da Vinci's words: "Simplicity is the ultimate sophistication." By streamlining these links, you've not only made the documentation more intuitive but also set the stage for a smoother, more maintainable future.

Your dedication to clarity and usability truly uplifts the experience for everyoneโ€”absolutely stellar work! ๐Ÿš€๐Ÿ™Œ

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants