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

Small fixes (images/links) to README.md #1

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Small fixes (images/links) to README.md #1

wants to merge 4 commits into from

Conversation

mzjp2
Copy link

@mzjp2 mzjp2 commented Oct 30, 2019

This looks great, guys! I've just got a few small fixes for the README:

  • Use the raw image file on GitHub, rather than the blob that you get to by navigating through using the repo tree, the image now displays in the README. 🚀
  • Also added slightly more relevant alt-text for accessibility reasons! 😄
  • Removed absolute links to sections in the README (that didn't work, brought up a GitHub 404 error) and replaced them with relative links and added the names of the links to each header so that it'd work. 🔗

One other thing, I notice that Code organization appears in the Table of Contents in a different order to where it does in the content. I wasn't sure which order was correct, so I left it as it is for now, but feel free to change it yourselves. 💯

This links to the raw image file on GitHub, rather than the `blob` that you get to by navigating through using the repo tree, the image now displays in the README. 🚀 Also added slightly more relevant alt-text for accessibility reasons! 😄
@mzjp2
Copy link
Author

mzjp2 commented Nov 6, 2019

@Lzejnilo just a nudge to look at this when you can. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant