Makes links in README relative file links, fix some of them #160
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I think it makes more sense to link to local files than to link to GitHub. Also, some of them were outdated so I fixed them. GitHub has support for this, see https://github.blog/2013-01-31-relative-links-in-markup-files/
|
Thanks for the fixes! My only concern is whether the relative links will also work correctly when other services (e.g. crates.io here: https://crates.io/crates/trustfall_core ) parse the README. Is that something you've already had a chance to look into? |
|
I had actually not thought of that, but it seems like something crates.io resolves according to this? |
obi1kenobi
approved these changes
Feb 14, 2023
|
Amazing, thanks for looking into it! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think it makes more sense to link to local files than to link to GitHub. Also, some of them were outdated so I fixed them.
GitHub has support for this, see https://github.blog/2013-01-31-relative-links-in-markup-files/