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

Initial Handbook structure #1

Merged
merged 15 commits into from
Oct 13, 2024
Merged

Initial Handbook structure #1

merged 15 commits into from
Oct 13, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Oct 13, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Updated the Ultralytics Handbook to include a broken link checker and detailed documentation.

πŸ“Š Key Changes

  • New CI Workflow: Added GitHub Actions to check for broken links using lychee.
  • Documentation Expansion: Introduced sections for mission, vision, values, roles, workflows, and more.
  • MkDocs Config: Set up a configuration for a structured handbook using MkDocs.

🎯 Purpose & Impact

  • Improved Reliability: Ensures website links are functioning, enhancing user experience.
  • Comprehensive Guide: Provides a clear insight into Ultralytics’ operations, aligning users with company principles.
  • Accessibility: Aids both internal and external contributors in understanding and participating in Ultralytics projects.

@UltralyticsAssistant UltralyticsAssistant added dependencies Dependencies and packages documentation Improvements or additions to documentation enhancement New feature or request labels Oct 13, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/handbook πŸš€ PR! To ensure a seamless integration of your work, please review the following checklist:

  • βœ… 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/handbook 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 improvements. "It is not daily increase but daily decrease, hack away the unessential." β€” Bruce Lee

For more guidance, please refer to our Contributing Guide. This is an automated response, but an Ultralytics engineer will review your PR soon. Thank you for contributing to Ultralytics! πŸŽ‰

@glenn-jocher glenn-jocher changed the title Update Handbook Initial Handbook structure Oct 13, 2024
@glenn-jocher glenn-jocher merged commit ece17e3 into main Oct 13, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the update branch October 13, 2024 20:11
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.

2 participants