docs
docs copied to clipboard
Check for circular links
๐ ๏ธ 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_linksinput in.github/workflows/links.ymlto enable/disable link checks by workflow_dispatch. - Add a new CI step to run
utils/check_links.pyagainst 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.pyto scan downloaded HTML for circular links andhref="#", outputting a concise report and settingLINK_ISSUESin 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.
The latest updates on your projects. Learn more about Vercel for GitHub.
| Project | Deployment | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| docs | Preview | Comment | Oct 30, 2025 2:58pm |
๐ 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/docsmainbranch. If it's behind, update it by clicking the 'Update branch' button or by runninggit pullandgit merge mainlocally. - โ 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! โจ๐งช