Broken Links in the docs

[kevinkhill]

Hello. I hope I reach you all as a fellow in hopes of helping, not nit picking 😃 With my intentions set, I ran your docs through a random link-checker site I found and 😮

[kevinkhill]

I'm happy to continue and open pull requests as I find them unless your team would rather just do it all as one thorough update

[bd82]

I wonder if we can automate the dead links checks as part of the CI process. The problem is that at some points in the life-cycle links may be temporarily invalid.

• e.g: until next version is actually deployed

Perhaps a script to check links would be useful, but only run it manually once in a while or maybe an automated daily build...

[kevinkhill]

I was thinking about this on my way to work this morning about some little script that could ping the links once deployed for 404s and then maybe collect them as a little report

On Wed, Jan 26, 2022, 3:56 PM Shahar Soel @.***> wrote:

I wonder if we can automate the dead links checks as part of the CI process. The problem is that at some points in the life-cycle links may be temporarily invalid.

• e.g: until next version is actually deployed

Perhaps a script to check links would be useful, but only run it manually once in a while or maybe an automated daily build...

— Reply to this email directly, view it on GitHub https://github.com/Chevrotain/chevrotain/issues/1751#issuecomment-1022711922, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACA6XCELC2MIZPE6ROCOJDUYCC37ANCNFSM5MYFUQQQ . You are receiving this because you authored the thread.Message ID: @.***>

[bd82]

There is a slight problem mapping the links back to the markdown But it should not be too hard, particularly once the situation is resolved and there would only be a few dead links once in a while...

I wonder if there is some npm package with a crawler that does it. I should be able to figure out how to do a daily execution of the script on Github Actions.

• https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule

[bd82]

This looks like a possible good option for the tool to be used

• https://www.npmjs.com/package/linkinator

[kevinkhill]

Skimming the README, it does sound very promising!

[bd82]

Unfortunately it seems linkinator does not work well with a Single Page Application such as the vuepress generated documentation.

[bd82]

This looks like a good website for checking dead links

• https://www.deadlinkchecker.com/website-dead-link-checker.asp

[bd82]

Bad links found:

• https://chevrotain.io/documentation/10_1_2/interfaces/iparserconfig.html
• http://chevrotain.io/docs/changes/docs/token_types.html
• https://github.com/chevrotain/chevrotain/tree/master/src/diagrams/render_public.ts
• https://chevrotain.io/documentation/10_1_2/interfaces/ilexingresult.html
• https://chevrotain.io/documentation/10_1_2/interfaces/ilexerconfig.html
• https://chevrotain.io/documentation/10_1_2/interfaces/itokenconfig.html
• https://jsperf.com/fill-16-bits
• https://chevrotain.io/docs/guide/custom_apis.html
• https://chevrotain.io/documentation/0_32_1/modules/_chevrotain_d*.html
• https://github.com/chevrotain/chevrotain/blob/master/docs/faq.md