Find and fix broken/dead links #54
Description
As see from #53 we can have broken/dead links, links that once worked can be unavailable for reasons outside the control of this project/repo!
Hence I have decided to manually scan (for now) the repo from time to time for such links and fix them - if there is one. Here are the steps to take:
New broken/dead links
- find missing links using,
markdown-link-check(see https://www.npmjs.com/package/markdown-link-check to find out how to install and use it) - once installed, use the below command in the root of the project:
$ ls **/*.md | xargs -n 1 markdown-link-check --quiet
### This recursively finds all markdown files in the repo,
### scans them and only reports those files which have
### broken/dead links in them.
- try to fix the broken/dead links by hand
- we are only looking for HTTP response code of 404, any other response codes can be ignored
- if a fix cannot be found, best mark the link with a '[deadlink]' marker
- in certain cases it's a good idea to leave the old link with the '[deadlink]' marker next to it even though we have found a new working one
Existing broken/dead links across the repo
Existing dead/broken links are marked with the '[deadlink]' marker.
As part of this issue, fixing these links is also helpful - although if they are left in there it's cause their fix wasn't immediately available or found on searching on the relevant sources.
Eventually, we can automate the task of finding such links via a GitHub action during GitHub events like commit, push or pull request creation.