Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: broken links and typos #6676

Merged
merged 2 commits into from
Jun 30, 2021
Merged

docs: broken links and typos #6676

merged 2 commits into from
Jun 30, 2021

Conversation

SethFalco
Copy link
Contributor

This is a minor contribution while I was working on making some badges.

Fixes a minor typo, it's "GitHub" not "Github".

In the API documentation the README is displayed.
However, relative links are kept relative, so they break as they should be linking to github.com, not contributing.shields.io.

This is resolved by using absolute URLs instead of relative URLs.

@shields-ci
Copy link

shields-ci commented Jun 27, 2021

Messages
📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

📖 ✨ Thanks for your contribution to Shields, @SethFalco!

Generated by 🚫 dangerJS against aa66131

@calebcartwright calebcartwright added the documentation Developer and end-user documentation label Jun 27, 2021
@calebcartwright
Copy link
Member

Thanks @SethFalco! The changes seem reasonable at first blush, though I do recall we had to make some tradeoffs with our documentation links because it wasn't possible to have them work everywhere. I'm unable to find the specifics because my GitHub search skills are failing me at the moment, but @chris48s do you recall the details/know if these proposed changes could have any potential unintended side effects?

@chris48s
Copy link
Member

#4139 still stands but there is nothing here that makes anything worse.
It is on my "if I suddenly have a pile of spare time.." list to have a look at other ways to generate contributing.shields.io but that is.. yet to transpire

Copy link
Member

@calebcartwright calebcartwright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@repo-ranger repo-ranger bot merged commit 856c71c into badges:master Jun 30, 2021
@SethFalco SethFalco deleted the docs branch July 3, 2021 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Developer and end-user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants