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 README.md #177

Merged
merged 5 commits into from
Mar 27, 2025
Merged

Update README.md #177

merged 5 commits into from
Mar 27, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Mar 27, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced the Ultralytics Docs README for clarity, accessibility, and improved user guidance.

πŸ“Š Key Changes

  • Updated the introduction to emphasize the comprehensive nature of Ultralytics Docs and linked key resources like YOLO models and machine learning glossary.
  • Improved installation instructions for the ultralytics package, adding clarity on developer mode and dependencies.
  • Refined guidance for building and serving documentation locally, including multi-language support and live preview features.
  • Expanded deployment instructions with detailed steps for GitHub Pages and other hosting options.
  • Enhanced contribution and licensing sections to encourage community involvement and clarify usage rights.

🎯 Purpose & Impact

  • Improved Usability: Clearer instructions make it easier for developers and contributors to navigate, install, and work with the documentation.
  • Enhanced Accessibility: Links to key resources and detailed steps ensure users of all expertise levels can effectively use and contribute to Ultralytics Docs.
  • Community Engagement: Encourages open-source contributions and feedback, fostering collaboration and innovation. πŸš€

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

vercel bot commented Mar 27, 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 Mar 27, 2025 7:21pm

Signed-off-by: Glenn Jocher <[email protected]>
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Mar 27, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting this ultralytics/docs πŸš€ PR! To ensure a smooth review and integration process, please review the checklist below:

  • βœ… Define a Purpose: Clearly explain the purpose of your update in the PR description, and link to any relevant issues. Ensure your commit messages are clear and aligned with the project's conventions.
  • βœ… Synchronize with Source: Verify that your branch is up-to-date with the ultralytics/docs main branch. If it's not, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Confirm that all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • βœ… Update Documentation: Double-check that all relevant documentation is updated to reflect your changes.
  • βœ… Add Tests: If applicable, include or update tests to ensure your changes are robust and confirm that all tests pass.
  • βœ… Sign the CLA: If this is your first contribution, please ensure you've signed our Contributor License Agreement by commenting, "I have read the CLA Document and I sign the CLA."
  • βœ… Minimize Changes: Limit your updates to only what is necessary for your enhancement or fix. As Bruce Lee wisely said, "Hack away the unessential."

For more details, please refer to our Contributing Guide. If you have any questions or need assistance, feel free to leave a comment here. An Ultralytics engineer will review your PR and provide feedback soon. Thank you for contributing to Ultralytics! πŸš€βœ¨

Signed-off-by: Glenn Jocher <[email protected]>
@glenn-jocher glenn-jocher merged commit 275cceb into main Mar 27, 2025
3 of 4 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch March 27, 2025 19:21
@UltralyticsAssistant
Copy link
Member

"πŸŽ‰ Huge thanks, @glenn-jocher, for this incredible contribution to Ultralytics Docs! Your enhancements bring clarity, accessibility, and inclusivity to the forefront, empowering our community to learn, build, and innovate with confidence. 🌟

As Albert Einstein once said, 'Strive not to be a success, but rather to be of value.' This PR exemplifies that value by making our resources more impactful and inviting for all. Your dedication to improving usability and fostering collaboration truly inspires us. πŸš€

Thank you for your continued commitment to excellence!"

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