docs(README): Replace relative paths with absolute URLs #37
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
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.
The default repo page presently renders broken benchmark graph images since the relative paths are not valid from this location (you'd have to symlink the related directory I guess?).
This also makes the WASM symlink probably not that useful, unless you're utilizing it somewhere else? Potentially consider a minimal README that links to the detailed talc subdir README, along with mention of the related dedicated WASM one? May be better than the symlink approach.
I'm not sure how you're using the relative links with the symlinks, but at least via the Web UI on Github, only the README in the main repo page is rendering the symlink, while directly viewing the
README.mdis similar to the early linked WASM symlink which just renders the symlink path.Side-note: You don't appear to use git tags in this repo to align with the tagged commits for your crate releases? That might be worth considering in future as a good practice (so the link I used above is to the latest repo commit).