Create a test for broken links

[mvaivre]

Many links aren't working right now (https://wiki.alephium.org/Desktop-Wallet-Guide.html#utxo-consolidation https://wiki.alephium.org/Desktop-Wallet-Guide.html#creating-a-mining-wallet-with-4-addresses).

Let's add a test to catch any broken link?

[nop33]

These are not working because we haven't published the wiki articles!

[nop33]

alephium/docs#46

[lf94]

It seems the links themselves are broken, the appropriate links are:

• https://wiki.alephium.org/wallet/Desktop-Wallet-Guide#utxo-consolidation
• https://wiki.alephium.org/wallet/Desktop-Wallet-Guide#creating-a-mining-wallet-with-4-addresses

[lf94]

Creating a test which relies on an external service isn't great; I suggest we just make sure the links are deployed already / near the same time. Otherwise the tests can one day just spontaneously fail due to network errors (unreachable, DNS resolution, etc).

[mvaivre]

IMO we will never be able to ensure that all the links are updated (and that a release is done) ahead of every article change (especially since other non-dev can be responsible for updating the wiki).
I prefer having a test fail rather than a dead link.
If a test fails and we realise that it's just a temporary issue, we can simply bypass the test. But it would force us to investigate.

[nop33]

I think adding a test will become every easier when we start translating our content. We will then have to move all our content to json or yaml or md files. We can then tell a GitHub Actions script to always parse those files, look for links, and validate them. I guess the same can be done with ts files.

[lf94]

Do we truly want to test all links to the Internet?

I can create a test that searches for links in our source code and test them all.

I'm thinking maybe the test can have a whitelist of domains which its allowed to test.

[mvaivre]

All links that are in our wallet - yes. Those will mostly point to our wiki / faq, but if they're in the UI, then it means that we've whitelisted them and we want them to work :)