exercism / docs

Exercism's docs. View them at Exercism's website, not on GitHub.
https://exercism.org/docs
42 stars 89 forks source link

README.md file under building/github has broken links #413

Closed vorenusCoA closed 1 year ago

vorenusCoA commented 1 year ago

In the README.md file, under the "Guides" section, there are 3 broken links:

I suggest deleting the first one since it looks like a duplicate from the "How to make a great Pull Request" from the starting paragraph of the same section.

For the second and third ones I think these would be the proper links: The Contributors' Guide to Pull Requests The Maintainers' Guide to Pull Requests

Please let me know if it is ok to open a PR for this. Thanks!

iHiD commented 1 year ago

Thanks. Have you noticed the bit in bold at the top of the README in this repo?

All three of these links work when I click on them: https://exercism.org/docs/building/github

vorenusCoA commented 1 year ago

Hi @iHiD, thanks for pointing that out (I hadn't seen it before).

You are correct, in the Exercism site the links work fine. A couple of questions:

iHiD commented 1 year ago

Great - thanks.

Should that link point to the Exercism site instead?

Yes. If you'd like to PR that, we'll gladly merge. Pls @ErikSchierboom in the PR.

What do you think about removing the second link to the How to make a great Pull Request?

I'll leave Erik to decide that 🙂

vorenusCoA commented 1 year ago

In order to have everything in the right place I will open an issue for updating the CONTRIBUTING file of the java track in the corresponding repo (and then will tag Erik in the PR).

Also, will open a new issue in this repo for removing the "extra link" and see if it is accepted.

Thank you @iHiD for the guidance.