thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
676 stars 170 forks source link

README: broken links #247

Closed dufcrule closed 2 years ago

dufcrule commented 2 years ago

I noticed a couple of broken links in the templates section of the README:

Screenshot 2022-05-25 at 08 08 59

Both the API Project overview (https://github.com/thegooddocsproject/templates/blob/dev/about-overview.md) and the Tutorial (https://github.com/thegooddocsproject/templates/blob/dev/tutorial/about-tutorial.md) links don't work.

Using relative refs instead of full URLs might fix this. For example:

Anita-ihuman commented 2 years ago

Can I take up this issue?

barbaricyawps commented 2 years ago

@Anita-ihuman , I think there's currently a PR in the repo that fixes it. I just haven't merged it in yet and the person who took the issue forgot to link it and follow our processes for opening PRs.

Anita-ihuman commented 2 years ago

Alright then