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

Fix lychee base-url #125

Merged
merged 2 commits into from
Nov 10, 2024
Merged

Fix lychee base-url #125

merged 2 commits into from
Nov 10, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Nov 9, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhancement to the GitHub workflow for verifying website links with improved URL handling.

πŸ“Š Key Changes

  • Added a new flag --base to the link-checking workflow to normalize URLs before checking them.

🎯 Purpose & Impact

  • Improved Workflow Reliability: This change allows the workflow to more accurately identify the base URLs, thereby reducing false positives where links might have been incorrectly flagged as broken. πŸ“ˆ
  • Enhanced User Experience: Users can expect more reliable and accurate documentation with fewer link errors in the published files, leading to a smoother navigational experience. 🧭

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Nov 9, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting a docs πŸš€ PR to the Ultralytics repository! To ensure a smooth integration of your changes, please review the following checklist:

  • βœ… Define a Purpose: Clearly explain the purpose of your update in the PR description, and link to any relevant issues. Ensure your commit messages are clear and concise, following the project's norms.
  • βœ… Synchronize with Source: Make sure your PR is up-to-date with the main branch. If it's outdated, update it by clicking 'Update branch' or by executing git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Check that all Ultralytics Continuous Integration (CI) checks pass. If any failures arise, please address them promptly.
  • βœ… Update Documentation: Ensure any new or modified features are documented in the relevant documentation.
  • βœ… Add Tests: If applicable, add or update tests to cover your changes, and confirm that all tests are successful.
  • βœ… Sign the CLA: Please sign our Contributor License Agreement if this is your first Ultralytics PR by commenting "I have read the CLA Document and I sign the CLA."
  • βœ… Minimize Changes: Limit your changes to the minimum needed for your update. Remember, "hack away the unessential." πŸ₯‹

This is an automated response. An Ultralytics engineer will review and provide further assistance soon. For additional information, please consult our Contributing Guide. Feel free to add comments if you have any questions. Thank you for your contribution! ✨

@glenn-jocher glenn-jocher merged commit 130464d into main Nov 10, 2024
2 of 4 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch November 10, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops GitHub Devops or MLops documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants