Skip to content

Update formatting, headers, and redirects - #23

Merged
glenn-jocher merged 2 commits into
mainfrom
update-format-headers-redirects-20260612201348
Jun 12, 2026
Merged

Update formatting, headers, and redirects#23
glenn-jocher merged 2 commits into
mainfrom
update-format-headers-redirects-20260612201348

Conversation

@pderrenger

@pderrenger pderrenger commented Jun 12, 2026

Copy link
Copy Markdown
Member

Updates repository maintenance artifacts:

  • formats supported source and config files
  • applies public AGPL source headers
  • formats Python docstrings
  • updates links to final redirect destinations

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

📝 This PR is a small documentation and wording cleanup that improves readability, updates links, and aligns repository references with current Ultralytics resources.

📊 Key Changes

  • Fixed minor spelling and wording in Google/plot_google_map.m comments:
    • “Acknowledgement” → “Acknowledgment”
    • “nearest neighbour” → “nearest neighbor”
  • Updated documentation links in README.md to use cleaned-up Ultralytics and related URLs.
  • Replaced the old Ultralytics HUB link with the current Ultralytics Platform link.
  • Kept contribution, licensing, and product references current and more consistent across the README.

🎯 Purpose & Impact

  • Improves overall polish and professionalism of the repository ✨
  • Makes README links cleaner and more reliable for users navigating Ultralytics docs and platforms 🔗
  • Helps new contributors find the right resources more easily, including the Ultralytics Platform for managing AI workflows 🚀
  • Has little to no impact on core functionality, since the code-related changes are comment-only 🛠️

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation HUB Ultralytics HUB issues priority: low Low urgency; can wait behind higher-priority work. labels Jun 12, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @pderrenger, thank you for submitting a ultralytics/msvm 🚀 PR! This is an automated message to help streamline review; an engineer will assist you shortly. Please review the checklist below to help ensure a smooth integration 😊

  • Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/msvm main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔍 PR Review

Made with ❤️ by Ultralytics Actions

Mostly a clean README-only refresh. The main follow-up is to finish the branding update consistently: line 60 still links to legacy YOLOv8 docs, and line 62 points to the new platform while keeping the old HUB product name.

💬 Posted 2 inline comments

Comment thread README.md
## 🤝 Contribute

We thrive on community contributions! If you're interested in fixing bugs, adding features, or improving documentation for MSVM or other [Ultralytics YOLO](https://docs.ultralytics.com/models/yolov8/) projects, your help is greatly appreciated. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for more details on how to get started.
We thrive on community contributions! If you're interested in fixing bugs, adding features, or improving documentation for MSVM or other [Ultralytics YOLO](https://docs.ultralytics.com/models/yolov8) projects, your help is greatly appreciated. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for more details on how to get started.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

💡 MEDIUM: This PR is framed as a branding/docs refresh, but this line still points contributors to the legacy YOLOv8 docs. That leaves the README inconsistent with current Ultralytics model positioning and sends users to older model documentation.

Suggested change:

Suggested change
We thrive on community contributions! If you're interested in fixing bugs, adding features, or improving documentation for MSVM or other [Ultralytics YOLO](https://docs.ultralytics.com/models/yolov8) projects, your help is greatly appreciated. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for more details on how to get started.
We thrive on community contributions! If you're interested in fixing bugs, adding features, or improving documentation for MSVM or other [Ultralytics YOLO26](https://docs.ultralytics.com/models/yolo26) projects, your help is greatly appreciated. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for more details on how to get started.

Comment thread README.md
We thrive on community contributions! If you're interested in fixing bugs, adding features, or improving documentation for MSVM or other [Ultralytics YOLO](https://docs.ultralytics.com/models/yolov8) projects, your help is greatly appreciated. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for more details on how to get started.

We also value your feedback on Ultralytics products and encourage you to share your experiences by completing our brief [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 thank you to all our contributors for supporting open-source AI! Explore more cutting-edge [AI solutions](https://docs.ultralytics.com/solutions/) and manage your projects with [Ultralytics HUB](https://www.ultralytics.com/hub).
We also value your feedback on Ultralytics products and encourage you to share your experiences by completing our brief [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 thank you to all our contributors for supporting open-source AI! Explore more cutting-edge [AI solutions](https://docs.ultralytics.com/solutions) and manage your projects with [Ultralytics HUB](https://platform.ultralytics.com/).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

📝 LOW: The destination has been updated to the current platform, but the anchor text still uses the retired "Ultralytics HUB" name. Keeping the old product name here is confusing in a branding cleanup PR.

Suggested change:

Suggested change
We also value your feedback on Ultralytics products and encourage you to share your experiences by completing our brief [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 thank you to all our contributors for supporting open-source AI! Explore more cutting-edge [AI solutions](https://docs.ultralytics.com/solutions) and manage your projects with [Ultralytics HUB](https://platform.ultralytics.com/).
We also value your feedback on Ultralytics products and encourage you to share your experiences by completing our brief [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 thank you to all our contributors for supporting open-source AI! Explore more cutting-edge [AI solutions](https://docs.ultralytics.com/solutions) and manage your projects with the [Ultralytics Platform](https://platform.ultralytics.com/).

@glenn-jocher
glenn-jocher merged commit 831edb6 into main Jun 12, 2026
3 checks passed
@glenn-jocher
glenn-jocher deleted the update-format-headers-redirects-20260612201348 branch June 12, 2026 20:41
@UltralyticsAssistant

Copy link
Copy Markdown
Member

Merged — thank you @pderrenger, with contributions from @glenn-jocher! 🎉

“Details make perfection, and perfection is not a detail.” — Leonardo da Vinci

This update is a great example of that idea in action: small wording fixes, cleaner links, and updated references to the Ultralytics Platform all help make the project more polished, readable, and welcoming for users and contributors alike. Really appreciate the care that went into keeping the docs current and consistent.

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 HUB Ultralytics HUB issues priority: low Low urgency; can wait behind higher-priority work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants