Use image URLs instead of relative paths, and add note to CONTRIBUTING.md
#163
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
owenpearson
approved these changes
Sep 1, 2021
github-actions
bot
temporarily deployed
to
staging/pull/163/dartdoc
# Conflicts: # README.md
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.
When referencing images in markdown files, using a local path such as
images/android.png, for examplewill result in the image missing on pub.dev README preview.I've suggested an improvement dart-lang/pub-dev#5068, but in the mean time it would be good to fix the images showing on pub.dev
Edit: The reason why this happens is pub.dev converts the image to the
masterbranch URL, e.g.https://github.com/ably/ably-flutter/raw/master/images/run-configuration-1.png, assuming the default branch is master. See dart-lang/pub-dev#5068