Fix broken links

[LorenzoMarnat]

The goal of this PR is to fix the links in UD-Viz documentation

remark -u validate-links . still returns 30 warnings (instead of 74)

[valentinMachado]

Thanks for fixing these links !
But we should begin by this issue #516 because some markdown are going to move from ./packages/*/src/** to ./docs/static/** meaning the link are going to be broken again

[valentinMachado]

@LorenzoMarnat Iam going to solve #516 on your branch.

This is done with commit 2f2766f let's fix these links !

[valentinMachado]

I put the FAILURE_THRESHOLD at 0 to detect every dead link

[DiegoVinasco]

This is great. In addition to this work however, we might want to consider a flaw with remark validate links...

Bascially, Remark doesn't validate absolute links (which are accepted by github in markdown documents). It only checks relative links or URLs.

This means that we might still have some broken links. This was worked around in the private repository here by using a sed command with some pipes to prefix absolute markdown links with a given URL:

export BASE_URI='https://github.com/VCityTeam/VCity/blob/master'
files=$(find . -name '*.md')
for f in $files
do
  grep -E '\[{1}.*\]{1}\({1}/{1}.*\){1}' "$f" | sed -i "s|](/|]($BASE_URI/|g" "$f"
done
remark -u validate-links .

I think it would be a good idea to do the same in UD-Viz. Maybe in a different PR? Any thoughts?

[valentinMachado]

This is great. In addition to this work however, we might want to consider a flaw with remark validate links...

Bascially, Remark doesn't validate absolute links (which are accepted by github in markdown documents). It only checks relative links or URLs.

This means that we might still have some broken links. This was worked around in the private repository here by using a sed command with some pipes to prefix absolute markdown links with a given URL:

export BASE_URI='https://github.com/VCityTeam/VCity/blob/master'
files=$(find . -name '*.md')
for f in $files
do
  grep -E '\[{1}.*\]{1}\({1}/{1}.*\){1}' "$f" | sed -i "s|](/|]($BASE_URI/|g" "$f"
done
remark -u validate-links .

I think it would be a good idea to do the same in UD-Viz. Maybe in a different PR? Any thoughts?

Since this PR is called "Fix broken links" imo we should let this open. I'm not sure to understand why there could be absolute link in .md, could you give an example of link that remark doesnt detect ?

[valentinMachado]

Actually absolute link should be consider as a bad practice since the root of the path will depend of the context in which it's interpreted (like vscode workspaces or github organization).

Iam going to add in the script validate-links a code to detect absolute links and throw an error if one is found.

Done, waiting for a review