Add a build test to check for broken links about documentation HOT 14 CLOSED

Broken link checker works a treat!

Sample extract of output:

blc http://localhost:3000/ -roe
Getting links from: http://localhost:3000/docs/how-prysm-works/bls-cryptography
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#proof-of-stake-pos (HTTP_404)
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#validator (HTTP_404)
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#proof-of-stake-pos (HTTP_404)
├─BROKEN─ http://localhost:3000/docs/glossaries/terminology.md#validator (HTTP_404)
Finished! 77 links found. 73 excluded. 4 broken.
Finished! 3774 links found. 3719 excluded. 4 broken.```

from documentation.

Docusaurus' already print out a list of unresolved links on static build

from documentation.

Can we add this to our CI pipeline?

Let me know it works and I can add something to fail PRs if they break links

from documentation.

Reopening as we've experienced issues with docusaurus link debugging feature

from documentation.

How does the link debugging work? Can we add it to CI pipeline?

from documentation.

Ping @har00ga

from documentation.

Another broken link: #94

from documentation.

Oh sorry, didnt see this notification. From what I gather it's something that can be run on a live site or hard coded into the docs themselves to have the checks performed, not sure which is ultimately simpler but if I had to guess, the live scan. It can likely be run against the live server and links can be checked before every revision push

from documentation.

Relevant issue: facebook/docusaurus#1111

The idea would be that we run this check on a new PR and fail that PR if it is breaking links. Running a live server doesn't seem viable in CI unless there is some example of it already.

from documentation.

@prestonvanloon Works for me, would be awesome to implement that if possible. Seeing as it works on the live server as well it would be good to make a note in the README that contributors should use the link tool before submitting a PR to reduce friction at merge time

from documentation.

#101 Link checking to be included as a step in this

from documentation.

If someone can help implement this as a github action, we could add it as a PR requirement.

from documentation.

@prestonvanloon Haven't worked with GH Actions before but will read into it this week

from documentation.

#175

from documentation.