CI: Check broken links in src doc comments

[2010YOUY01]

Is your feature request related to a problem or challenge?

#16830 fixed several invalid links in the doc comments.

It would be great to setup a CI job, to check those links automatically.

Describe the solution you'd like

cargo-deadlinks can be helpful https://github.com/deadlinks/cargo-deadlinks

Describe alternatives you've considered

No response

Additional context

No response

[Adez017]

take

[Adez017]

hi @2010YOUY01 i would try to validate the concerned issue and find out a way

[2010YOUY01]

hi @2010YOUY01 i would try to validate the concerned issue and find out a way

Thank you.

You can try lychee mentioned by #16839 (comment), it seem to have existing GitHub action to use.

[Adez017]

hi @2010YOUY01 i would try to validate the concerned issue and find out a way

Thank you.

You can try lychee mentioned by #16839 (comment), it seem to have existing GitHub action to use.

great will look into it

[jcsherin]

@Adez017 Thank you. These are the commands I used.

To generate rust docs (same as ci/scripts/rust_docs.sh):

$ RUSTDOCFLAGS="-D warnings" cargo doc --document-private-items --no-deps --workspace

To generate a markdown report of broken links using lychee:

$fd -e html -e txt -e md . target/doc | xargs lychee --github-token "$GITHUB_TOKEN" --format markdown > lychee_report.md

The $GITHUB_TOKEN is necessary to prevent HTTP 429 (too many requests) when checking github urls.