Correct broken links in README.md

[MikeMcC399]

This PR resolves issue #663 "Broken links in README"

It corrects bad links in the README.md document which caused 400 (Bad Request) and 404 (Not Found) errors.

In addition it replaces links in README.md which were previously pointing to documents on https://help.github.com/. Links now use https://docs.github.com/ instead.

The use of the new links takes account of the help restructuring by bundling some links together for a better user experience and to better isolate from possible future GitHub help document restructuring.

---

GitHub has been restructured and

• the top level of https://help.github.com/ now forwards to https://support.github.com/
• individual articles on https://help.github.com/ are being forwarded to https://docs.github.com/

Verification

Execute npm run check:markdown and ensure that there are no Status 400 (Bad Request) or 404 (Not Found) errors.

NOTE
This PR does not solve 403 Forbidden errors. This is the subject of issue #664.

[jaffrepaul]

Good stuff! While this fixed outdated Cypress links, I'm seeing a handful of dead Github links when running npm run check:markdown in the repo root. Rather, they do actually work if you navigate manually. Maybe the "help" subdomain is doing some fancy server redirects 🤷‍♂️

Would you mind updating these to the docs.github.com/en/xxx while you're in here? 💪

[MikeMcC399]

Good stuff! While this fixed outdated Cypress links, I'm seeing a handful of dead Github links when running npm run check:markdown in the repo root. Rather, they do actually work if you navigate manually. Maybe the "help" subdomain is doing some fancy server redirects 🤷‍♂️

The links which work but produce errors are throwing 403 forbidden errors. Since there were multiple things going wrong I split up the 403 problem into a different issue (#664). Sorry I didn't explain that here better!

Would you mind updating these to the docs.github.com/en/xxx while you're in here? 💪

I have done as you asked and converted the links to docs.github.com/en/xxx. They still produce a 403 forbidden error though, but at least they are all now using the current domain and not relying on redirects. I also added this information to the original posting.

I accelerated submitting the solution to the 403 error and you now have another PR (#667) to look at! Taken together they should solve the link issues. It would be best to merge the broken links PR (this one) before the 403 PR (#667) in order to avoid main.yml failing if it correctly finds failing links.

[github-actions]

🎉 This PR is included in version 5.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀