Skip to content

Conversation

@onuralpszr
Copy link
Member

@onuralpszr onuralpszr commented Dec 20, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Adds a Lychee ignore list to skip known-problematic links during docs link checking πŸ”—βœ…

πŸ“Š Key Changes

  • Added a new .lycheeignore file to configure Lychee’s link checker exclusions 🧾
  • Documented how the ignore file works (regex per line, comments supported) πŸ“˜
  • Ignored two specific GitHub URLs for @0xSynapse (profile + avatar) that were returning 404s 🚫
  • Left a placeholder section for future broken links to be added as needed πŸ› οΈ

🎯 Purpose & Impact

  • Reduces false-positive failures in automated link checks, making CI/docs validation more reliable βœ…
  • Keeps link-checking reports cleaner by excluding known non-actionable 404s 🧹
  • Provides a clear, maintainable mechanism for handling recurring broken/external links over time πŸ“Œ

Signed-off-by: Onuralp SEZER <onuralp@ultralytics.com>
@vercel
Copy link

vercel bot commented Dec 20, 2025

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

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Dec 20, 2025 0:31am

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops enhancement New feature or request labels Dec 20, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @onuralpszr, thank you for submitting a ultralytics/docs πŸš€ PR! This is an automated message, and an Ultralytics engineer will assist you shortly. 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. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! πŸš€

Copy link
Member

@UltralyticsAssistant UltralyticsAssistant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ” PR Review

Made with ❀️ by Ultralytics Actions

Clean addition overall: a dedicated .lycheeignore with clear inline guidance reduces noisy link-check failures and is easy to maintain. The only issue is the GitHub avatar ignore pattern being overly narrow; widening it will make the ignore robust to common query-string variants and avoid future CI regressions.

πŸ’¬ Posted 1 inline comment

@onuralpszr onuralpszr changed the title feat: Add .lycheeignore to exclude specific URLs from link checks. feat: Add .lycheeignore to exclude specific github author URLs from link checks. Dec 20, 2025
@onuralpszr onuralpszr self-assigned this Dec 21, 2025
@onuralpszr
Copy link
Member Author

cc @glenn-jocher friendly ping for review for fixing author URL problem.

@glenn-jocher glenn-jocher merged commit f5c6809 into main Dec 22, 2025
7 of 9 checks passed
@glenn-jocher glenn-jocher deleted the docs/ignore-gh-user-profile branch December 22, 2025 09:41
@UltralyticsAssistant
Copy link
Member

Merged β€” huge thanks @onuralpszr for this thoughtful improvement, and appreciation to @glenn-jocher for the support and collaboration on it. πŸ™Œ

As Benjamin Franklin put it, β€œAn ounce of prevention is worth a pound of cure.” This PR nails that idea: adding .lycheeignore prevents noisy, non-actionable 404s from derailing docs CI, keeps link-check reports clean, and gives the team a clear, maintainable place to handle recurring external link issues over time.

Thanks again for making the docs pipeline more reliable for everyone contributing to Ultralytics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devops GitHub Devops or MLops enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants