Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README.md #14

Merged
merged 1 commit into from
Nov 13, 2023
Merged

Update README.md #14

merged 1 commit into from
Nov 13, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Nov 13, 2023

copilot:all

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Updated and streamlined the Ultralytics documentation README for clarity and added multi-language support instructions.

πŸ“Š Key Changes

  • Improved link to GitHub Actions workflow to show badge for gh-pages branch specifically.
  • Simplified the installation instructions for the Ultralytics package in developer mode by merging lines for clarity.
  • Cleaned up the section on building and serving locally, by combining lines and removing redundancy.
  • Added a new section with detailed steps on how to build and serve documentation for multiple languages.
  • Ensured that the deployment section succinctly covers key information on how to deploy the MkDocs site.

🎯 Purpose & Impact

  • πŸ“ˆ Enhanced readability by reducing clutter in installation and building instructions.
  • 🌐 Multi-language support detail will assist developers in generating localized documentation, expanding the reach of Ultralytics documentation to non-English speaking users.
  • πŸ“ Ensured developers can easily follow the steps to build, serve, and deploy their documentation in multiple languages, improving international accessibility and user experience.

@glenn-jocher glenn-jocher merged commit 2d7f60e into main Nov 13, 2023
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch November 13, 2023 14:55
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant