feat: add CI workflow to check for broken links

[Vimal-Shady]

Before submitting

• Was this discussed/agreed via a Github issue? (Follow-up from previous PR 🐛 Fix broken 'Get Started' link in README #674)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure to update the docs? (N/A)
• Did you write any new necessary tests? (N/A - CI workflow only)

What does this PR do?

• Adds a GitHub Actions workflow to automatically check for broken Markdown links
  • File: .github/workflows/ci-check-md-links.yml
  • Uses: Lightning-AI/utilities/.github/workflows/check-md-links.yml@main
• Adds a config file:
  • .github/markdown-links-config.json
  • Ignores localhost/example URLs and sets retry behavior

PR review

This PR adds CI support only, no application logic is changed.
Community members are welcome to review once the checks pass.

Did you have fun?

Yes! Happy to help improve CI and prevent future broken links 🙌

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84%. Comparing base (9eff5cc) to head (761f16e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@         Coverage Diff         @@
##           main   #676   +/-   ##
===================================
  Coverage    84%    84%           
===================================
  Files        52     52           
  Lines      7144   7144           
===================================
  Hits       5966   5966           
  Misses     1178   1178           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[bhimrazy]

Thanks @Vimal-Shady for the PR!

It seems like it's currently marking all the links as dead. Maybe we need to add and try with a config similar to this one.

[tchaton]

Nice !