fuels-ts icon indicating copy to clipboard operation
fuels-ts copied to clipboard

Markdown validation not validating markdown link fragments

Open petertonysmith94 opened this issue 1 year ago • 3 comments

We have links to sections on a page #typegen (see example). There is currently no validation to check that they exist and therefore, are broken.|

We should add validation to ensure that, all our links work as expects, so the user can navigate the documentation with ease.

petertonysmith94 avatar Apr 23 '24 06:04 petertonysmith94

Might be worth adding a CI job with a markdown link checker such as https://github.com/tcort/markdown-link-check

maschad avatar Apr 29 '24 17:04 maschad

Like this one? .github/workflows/md-lint.yaml

cc @Dhaiwat10

arboleya avatar Apr 30 '24 00:04 arboleya

Looks to me the rule no-dead-link is not being applied.

petertonysmith94 avatar Apr 30 '24 07:04 petertonysmith94