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

Adds dependencies and TOML updates #19

Merged
merged 3 commits into from
Nov 12, 2024
Merged

Adds dependencies and TOML updates #19

merged 3 commits into from
Nov 12, 2024

Conversation

Burhan-Q
Copy link
Contributor

@Burhan-Q Burhan-Q commented Oct 23, 2024

  • Include dependencies for building docs locally (copied from Ultralytics repo)
  • Replace "template" with "handbook"

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Renaming and updating dependencies for the Ultralytics Handbook project to enhance documentation and functionality.

πŸ“Š Key Changes

  • Project name updated from "template" to "handbook".
  • Updated project description and keywords to align with the new name.
  • Modified project URLs to reflect the "handbook" repository.
  • Expanded dependencies to include packages focused on documentation and testing, such as mkdocs-material, pytest, and others.

🎯 Purpose & Impact

  • Improved Clarity: The renaming from "template" to "handbook" clarifies the purpose and content of the package, aligning it with its intended use.
  • Enhanced Documentation: New dependencies like mkdocs and its plugins support richer and more dynamic documentation, benefiting users by making information more accessible and engaging.
  • Better Testing: Incorporation of testing tools like pytest ensures more robust code quality and reliability, ultimately enhancing user trust and satisfaction.

@Burhan-Q Burhan-Q added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 23, 2024
@Burhan-Q Burhan-Q self-assigned this Oct 23, 2024
@UltralyticsAssistant UltralyticsAssistant added the dependencies Dependencies and packages label Oct 23, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @Burhan-Q, thank you for submitting your pull request to the ultralytics/handbook repository! πŸš€ This is an automated response to help guide you through the contribution process. Please review the checklist below to ensure everything is in order:

  • βœ… Define a Purpose: Double-check that the purpose of your changes is clearly detailed in your PR description. If available, link to any relevant issues in the handbook issues section. Ensure your commit messages are explicit and consistent with our conventions.
  • βœ… Synchronize with Source: Ensure your branch is up-to-date with the main branch of ultralytics/handbook. If necessary, update it by clicking the 'Update branch' button or by running git pull and git merge main on your local setup.
  • βœ… Pass CI Checks: All Ultralytics Continuous Integration (CI) checks should be passing. Please investigate and resolve any failures if they occur.
  • βœ… Update Documentation: If your changes include new features or alterations, please update the relevant documentation.
  • βœ… Add Tests: If applicable, include or revise tests to ensure your changes are fully covered and confirm that all tests are successful.
  • βœ… Sign the CLA: For your first contribution to Ultralytics, sign the Contributor License Agreement by affirming "I have read the CLA Document and I sign the CLA" in a new message.
  • βœ… Minimize Changes: Keep your modifications to the essential minimum needed for the updates you are proposing, following the principle: "It is not daily increase but daily decrease, hack away the unessential."

For more detailed guidance, visit our Contributing Guide. If you have any questions or need further clarification, feel free to leave a comment here. An Ultralytics engineer will review your submission soon. Thanks again for contributing to Ultralytics! 🌟

@glenn-jocher
Copy link
Member

@Burhan-Q good updates!

@glenn-jocher glenn-jocher merged commit da245ca into main Nov 12, 2024
1 check failed
@glenn-jocher glenn-jocher deleted the deps branch November 12, 2024 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Dependencies and packages documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants