Skip to content

Update README.md #1

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

Merged
merged 1 commit into from
Feb 10, 2023
Merged

Update README.md #1

merged 1 commit into from
Feb 10, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Feb 10, 2023

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Comprehensive guide added for Ultralytics documentation setup, local serving, and deployment.

πŸ“Š Key Changes

  • Detailed instructions for installing the Ultralytics package in developer mode.
  • Steps for building and serving the documentation site locally with MkDocs.
  • Notes on how to deploy the documentation site using various platforms like GitHub Pages and options for setting a custom domain.
  • A representative screenshot for setting a custom domain on GitHub Pages included.

🎯 Purpose & Impact

  • User-Friendly Guidance: Helps both new and experienced users install and contribute to the Ultralytics documentation with ease.
  • Immediate Reflection: Enables contributors to instantly see the effect of their changes locally, promoting efficient testing and debugging.
  • Streamlined Deployment: Clarifies the deployment process, making it easier for maintainers to update and manage the live documentation site.
  • Visual Aid: The added screenshot serves as a quick reference for configuring a custom domain, enhancing user understanding.

@glenn-jocher glenn-jocher merged commit 278297d into main Feb 10, 2023
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch February 10, 2023 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant