Fix broken links

[norswap]

Closes #115 and #116

Built on top on #117, don't merge!

Uses https://github.com/lycheeverse/lychee for link checking.

A bit unsure about the github workflow, needs testing. It works.

I'm expecting the workflow to fail at first, because we have one link to a build output, so either
we must add contract building to the workflow, or add an exception.
It passes, but that itself is a problem, because it's caused by lychee not checking absolute (/-prefixed) links.

[norswap]

Maybe just remove this link and display the path textually instead. @maurelian wdyt?

[maurelian]

Agree. I made a suggestion below that I think gets this across well.

[norswap]

I couldn't get it to check absolute links. Opened an issue @ lychee here: https://github.com/lycheeverse/lychee-action/issues/70

In the meantime, I've changed the absolute links from deposits.md to be relative, except for the artifact links, which will therefore be conveniently ignored (though I think we should probably change that by a textual path, see my comment).

[norswap]

Following @trianglesphere's comment, I rechecked and found quite a few more broken link references (e.g. [text][link-ref]). Would be nice if the tool could catch those automatically too.

Lychee issue: lycheeverse/lychee#456

[maurelian]

I think it's good with these small changes

[maurelian]

Agree. I made a suggestion below that I think gets this across well.

[norswap]

• had to exclude twitter.com because of rate limiting
• had to exclude email address because this
• I'm explicitly listing files to lint more restrictively, otherwise this gets quite slow locally as it's trying to file markdown files in .git and node_modules
  • this does mean that I'm not currently linting markdown file in the javascript packages
  • we could add markdown files one by one though
  • this would fix it