Skip to content

Fix broken links in README.md #303

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

Merged
merged 1 commit into from
Jul 10, 2023
Merged

Conversation

kkebo
Copy link
Contributor

@kkebo kkebo commented Jul 10, 2023

It seems that fixing relative links was forgotten when the README.md was moved in #270.

@davdroman
Copy link
Collaborator

Good shout, though I think we need to use absolute links here since the origin page can vary (/ or /README.md). Mind making the change?

@kkebo
Copy link
Contributor Author

kkebo commented Jul 10, 2023

@davdroman Thank you for your suggestion, but GitHub recommends using relative links instead of absolute links.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes#relative-links-and-image-paths-in-readme-files

Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.

@davdroman
Copy link
Collaborator

Fair. Just tested and it works from both locations which I didn’t know. So merging. Thanks for your contribution!

@davdroman davdroman merged commit 2b8e809 into siteline:master Jul 10, 2023
@kkebo kkebo deleted the fix-broken-links branch July 10, 2023 23:57
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.

2 participants