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

Remove extra html strings #165

Merged
merged 2 commits into from
Jan 28, 2025
Merged

Remove extra html strings #165

merged 2 commits into from
Jan 28, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 28, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Cleaned up extraneous HTML content from multiple model comparison documentation pages to improve readability and maintainability.

📊 Key Changes

  • 🚫 Removed unnecessary html markers from seven documentation files comparing various object detection models (e.g., YOLOv9 vs EfficientDet, YOLOv6 vs YOLOv7).
  • 🧹 Simplified script references for benchmarks by retaining relevant <script> tags while discarding redundant code snippets.

🎯 Purpose & Impact

  • 📝 Improved Readability: Streamlined the documentation by removing unused and confusing tags, making the pages clearer for users.
  • 🔧 Easier Maintenance: Reduces clutter, making it easier for developers to manage and update the documentation.
  • 🌐 Enhanced User Experience: Users can focus on model-specific information without unnecessary distractions or clutter.

Copy link

vercel bot commented Jan 28, 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 Jan 28, 2025 1:15pm

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Jan 28, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/docs 🚀 PR! Your efforts in refining the documentation and removing extraneous html strings are very much appreciated. To ensure a smooth review and integration, please take a moment to verify the following checklist:

  • Define a Clear Purpose: Ensure that the purpose of your PR is well-explained in the description. It appears you're enhancing documentation readability—great work! If relevant, consider linking any associated issues to provide further context.

  • Synchronize Branch: Check that your branch is up-to-date with the main branch of the ultralytics/docs repository.

    You can update your branch directly by using the 'Update branch' button on this PR, or locally by running:

    git pull origin main
    git merge main
  • CI Compliance: Confirm that all required Continuous Integration (CI) checks are passing. If something fails, please address the issues promptly. More on our CI process can be found here.

  • Documentation Relevance: Since this PR impacts documentation, ensure all affected pages are updated accurately and maintain consistency. The updates aim to make content cleaner, which is fantastic!

  • Testing Scope (if applicable): While this PR focuses on content cleanup, for code-related PRs, we recommend adding or updating tests to verify changes, ensuring no regressions occur.

  • CLA Compliance: Have you signed the Ultralytics Contributor License Agreement (CLA)? If not, please sign it by commenting "I have read the CLA Document and I sign the CLA" on this PR. This step is mandatory for your contributions to be merged.

"In simplicity, there is beauty." 🌟 — This cleanup embodies that! If you have additional cleanup spots or style adjustments in mind, feel free to share or include them here. For further insight into our contribution process, kindly refer to our detailed Contributing Guide.

⚠️ This is an automated response to guide you through the PR process. An Ultralytics engineer will review your work and provide further feedback soon. Thanks again for your contribution to making Ultralytics documentation better! 🚀

@glenn-jocher glenn-jocher merged commit 9805372 into main Jan 28, 2025
4 checks passed
@glenn-jocher glenn-jocher deleted the remove-html branch January 28, 2025 13:16
@UltralyticsAssistant
Copy link
Member

🚀 PR Merged! A huge thanks to @glenn-jocher for cleaning up our model comparison documentation! Your thoughtful work to improve readability and maintainability truly elevates the experience for everyone engaging with our resources. 🌟

As Leonardo da Vinci once said, “Simplicity is the ultimate sophistication.” By decluttering and refining our docs, you've embraced this principle and made it simpler for the community to learn, build, and create. Your contributions are making a meaningful difference—thank you for your dedication and attention to detail! 🙌

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