mi6
Explore adding a check for broken markdown links
Summary
Explore whether we could add a check to our PR workflow for the ic-design-system repo which looks for broken links in our markdown / guidance.
💬 Description
When moving pages on our website to different locations, or changing the names of pages, links to these pages need updating and occasionally some of these links can get missed meaning they become broken.
It would be good to explore whether we can add a check to our ic-design-system workflow for when a PR is opened which will detect any broken links.
From a quick Google search, it seems that there are tools available which might allow this, e.g. see Markdown Link Checking in GitHub with Actions, or Lychee, so hopefully it should be possible.
💰 Use value
To ensure we don't have any broken links on our website.
Additional info
I think that if a solution is found while exploring this, it would be good to implement it as part of this ticket - unless it will take a lot of effort; in which case, open a new ticket.
