docs icon indicating copy to clipboard operation
docs copied to clipboard

Check for circular links

Open glenn-jocher opened this issue 1 month ago โ€ข 2 comments

๐Ÿ› ๏ธ PR Summary

Made with โค๏ธ by Ultralytics Actions

๐ŸŒŸ Summary

Add automated detection of circular links and empty hrefs to docs site CI, with optional control and Slack notifications. ๐Ÿ”—๐Ÿ›ก๏ธ

๐Ÿ“Š Key Changes

  • Introduce check_circular_links input in .github/workflows/links.yml to enable/disable link checks by workflow_dispatch.
  • Add a new CI step to run utils/check_links.py against each target website, continuing on error to avoid blocking.
  • Implement Slack notifications for link issues on scheduled runs, posting summarized findings from LINK_ISSUES.
  • Add utils/check_links.py to scan downloaded HTML for circular links and href="#", outputting a concise report and setting LINK_ISSUES in the environment.

๐ŸŽฏ Purpose & Impact

  • Proactively catch UX issues (self-referential links, empty anchors) before users encounter them.
  • Improve site quality and navigation integrity across deployments.
  • Provide actionable, lightweight summaries to Slack for quick triage without failing most CI runs.
  • Maintain flexibility with a toggleable check for manual runs.

glenn-jocher avatar Oct 29 '25 15:10 glenn-jocher

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Oct 30, 2025 2:58pm

vercel[bot] avatar Oct 29 '25 15:10 vercel[bot]

๐Ÿ‘‹ Hello @glenn-jocher, thank you for submitting a ultralytics/docs ๐Ÿš€ 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/docs 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 bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." โ€” Bruce Lee

For more guidance, please refer to our Contributing Guide. This is an automated message and an engineer will assist you shortly. Thank you for contributing to Ultralytics! โœจ๐Ÿงช

UltralyticsAssistant avatar Oct 29 '25 15:10 UltralyticsAssistant