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

Add lychee --base arg #142

Closed
wants to merge 1 commit into from
Closed

Add lychee --base arg #142

wants to merge 1 commit into from

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 1, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced the link-checking workflow for improved flexibility and accuracy. πŸ› οΈπŸ”—

πŸ“Š Key Changes

  • Updated the lychee command in the GitHub Actions workflow to include a --base parameter for URLs.
  • Ensured links are checked relative to a specified base URL (https://${{ matrix.website }}).

🎯 Purpose & Impact

  • πŸ—οΈ Flexibility: Allows the workflow to dynamically check links against different base websites (e.g., staging or production).
  • βœ… Accuracy: Improves the reliability of link validation, ensuring links are checked in the right context.
  • πŸš€ User Benefit: Reduces the risk of broken links in documentation, boosting user trust and experience.

Signed-off-by: Glenn Jocher <[email protected]>
Copy link

vercel bot commented Jan 1, 2025

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
docs πŸ”„ Building (Inspect) Visit Preview Jan 1, 2025 5:33pm

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation enhancement New feature or request labels Jan 1, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/docs πŸš€ PR! To ensure your contribution is seamlessly integrated, please review the following checklist:

  • βœ… Define a Purpose: Ensure your PR description clearly explains its purpose and links to any relevant issues. Commit messages should remain clear, concise, and adhere to the repository's conventions.
  • βœ… Synchronize with Source: Verify that your branch is up-to-date with the main branch of the ultralytics/docs repository. You can do this by clicking the 'Update branch' button or running git pull followed by git merge main locally.
  • βœ… Ensure CI Checks Pass: Confirm that all Ultralytics Continuous Integration (CI) checks pass successfully. If any checks fail, kindly resolve the identified issues.
  • βœ… Update Documentation: If your PR introduces or alters functionality, update or add the relevant documentation pages to reflect those changes.
  • βœ… Add Tests: If applicable, ensure that new or updated tests are included to cover your changes and that all tests pass.
  • βœ… Sign the CLA: Ensure the Contributor License Agreement has been signed, particularly if this is your first time contributing. You can do so by adding a comment containing "I have read the CLA Document and I sign the CLA." You can find more details about the CLA here.
  • βœ… Minimize Changes: Confirm that your PR introduces only the necessary changes for your fix or feature. Remember: "It is not daily increase but daily decrease, hack away the unessential." β€” Bruce Lee.

Additional Notes for Your PR

Your proposed changes enhance the link checker workflow by including the --base argument for dynamic base URLs, which can significantly improve link validation accuracy. πŸ”—βœ¨ Great work! Just ensure the checklist above is adhered to for a smooth integration πŸš€.

For further guidelines, please consult the Contributing Guide. If you have any questions or need assistance, don't hesitate to leave a comment here. 😊

This is an automated response πŸ€–, but rest assured that an Ultralytics engineer will review your PR in detail and provide additional feedback soon. Thank you for contributing to Ultralytics! πŸš€

@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch January 1, 2025 17:47
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants