[CI] Add check for broken links in our documentation

[Lucas-C]

Currently pending this fixup: JustinBeckwith/linkinator-action#234

By submitting this pull request, I confirm that my contribution is made under the terms of the GNU LGPL 3.0 license.

[andersonhc]

I was wondering if we could consider using something like https://github.com/actions/cache
to cache external resources, which might help make the doc job more reliable.

My sense is that the issue isn’t a broken link, but rather that the external resource is occasionally unavailable (possibly due to throttling or transient network issues).

[Lucas-C]

I was wondering if we could consider using something like https://github.com/actions/cache to cache external resources, which might help make the doc job more reliable.

My sense is that the issue isn’t a broken link, but rather that the external resource is occasionally unavailable (possibly due to throttling or transient network issues).

In the end I resolved the issue with borb SVG logo in PR #1749
I'm not sure that adding caching to the docs CI job would be really useful, but I'm totally open to experiment & try new approaches 🙂