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 Handbook Structure #2

Merged
merged 8 commits into from
Oct 13, 2024
Merged

Update Handbook Structure #2

merged 8 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

This PR introduces automated workflows for publishing and version tagging of the Ultralytics handbook.

πŸ“Š Key Changes

  • New GitHub Actions:
    • Added workflows for publishing the handbook to GitHub Pages.
    • Introduced a tagging and releasing workflow.
  • JavaScript and CSS Enhancements:
    • Implemented light/dark theme detection and Inkeep chat button functionality.
  • Documentation Updates:
    • Modified layout and included event banners.
    • Adjusted navigation structure for better organization.

🎯 Purpose & Impact

  • Automation: Simplifies the process of publishing and maintaining the handbook, saving time and reducing manual errors.
  • User Experience: Enhances readability and accessibility with theme adaptation and improved documentation layout.
  • Engagement: Encourages user interaction through the Inkeep chat button, facilitating easier access to support and feedback channels.

@UltralyticsAssistant UltralyticsAssistant added 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! This is an automated response to help guide your contribution, and an Ultralytics engineer will also assist you soon. Let's ensure a smooth integration by reviewing the following checklist:

  • βœ… Define a Purpose: Clearly explain the purpose of your update in your PR description, and link to any relevant issues if applicable. Make sure your commit messages are clear, concise, and follow the project's conventions.
  • βœ… Synchronize with Source: Verify your PR is up-to-date 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.
  • βœ… Ensure CI Checks Pass: Ensure all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • βœ… Update Documentation: Reflect any changes in the relevant documentation if necessary.
  • βœ… Add Tests: If applicable, ensure tests are included or updated to cover your changes and verify all tests pass.
  • βœ… Sign the CLA: Confirm that you have signed the Contributor License Agreement by writing "I have read the CLA Document and I sign the CLA" if this is your first contribution.
  • βœ… Minimize Changes: Keep your changes concise, focusing on the necessary adjustments for your update. As Bruce Lee wisely put it: "Hack away the unessential. The closer to the source, the less wastage there is."

For more detailed guidance, please see our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for enhancing Ultralytics! πŸš€

@glenn-jocher glenn-jocher changed the title Update Handbook Update Handbook Structure Oct 13, 2024
@glenn-jocher glenn-jocher merged commit c2a55e5 into main Oct 13, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the updates branch October 13, 2024 23:41
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants