Fix links online doc

[valentinMachado]

When jsdoc is generating the online documentation based on markdown files (ones in that repository) relative path in markdown files (which are correct in a github environment or a vscode environment) are broken in html files generated.

Since we want our online documentation (html generated) and our github/desktop environment (markdown files) to resolve these path, one approach could be to put URL everywhere (with some hack required).

Maybe is it possible to fix this problem by configuring jsdoc html generation ?

This could be also an opportunity to develop a CI test which could generate the online doc and then parse it clicking every link, to check online dead links (could already exists)

related #552
same problem here 2016

[valentinMachado]

https://www.npmjs.com/package/dead-link => introduce 13 high + 2 critical vulnerabilities
https://www.npmjs.com/package/dead-link-checker => introduce 4 moderate vulnerabilities

which for the both are not fixable with npm audit fix

[valentinMachado]

found one npm package checking html url but we are force to use 0.6.7 version because newer version have vulnerabilities

EDIT 1: the version 0.6.7 do not propose the SiteChecker class and seems to not working properly, since url cannot be parsed. I tried with the latest version and the SiteChecker class which appear to work so for now I'll implement this solution and wait for vulnerabilities to be fix

EDIT 2: ongoing

[valentinMachado]

A first solution for the CI test have been implemented on this branch

It just check internal links and found 391 broken links.

npm audit report

robots-txt-guard <1.0.2
Severity: high
robots-txt-guard Inefficient Regular Expression Complexity vulnerability - GHSA-6g33-8w2q-4hxv
fix available via npm audit fix --force
Will install [email protected], which is a breaking change
node_modules/robots-txt-guard
broken-link-checker >=0.7.0
Depends on vulnerable versions of robots-txt-guard
node_modules/broken-link-checker

2 high severity vulnerabilities

You can test this CI by running node ./bin/checkBrokenLinkDocSite.js /!\ this command will generate the doc html which you don't want to commit