Repository navigation
docs(readme): add preview image to the README - #6
Merged
Merged
Conversation
Adds a 16:9 screenshot of the public /preview page as a README hero, so the repo landing page shows what the template looks like before anyone clicks through to the live deployment.
Uzair-Ahmed-Dahraj
left a comment
Uzair-Ahmed-Dahraj
left a comment
Collaborator
Author
There was a problem hiding this comment.
Reviewed, If needed preview will be swapped with actual Polaris UI preview.
Fine according to cloudflare contributing guide, they need a preview anyway, no mention of what to do incase of an embedded app.
This file contains hidden or 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
1 participant
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.
What
Adds a 16:9 screenshot of the public
/previewpage as a README hero image, placed just under the Deploy to Cloudflare button.Why
The repo is being open-sourced and submitted to cloudflare/templates. Right now the README opens with badges and a text description only, so a visitor has to click through to the live deployment to see what the template actually looks like.
Cloudflare's own contributing guide asks for this: "You should also include a screenshot and/or live deployment of the application", and their template checklist asks for a 16:9 preview image at least 500px wide. This image is 3200x1800.
Notes
<!-- dash-content-start -->marker, so it is excluded from the block Cloudflare renders in the dashboard, where a relative path would not resolve.cloudflare.preview_image_url. That field can only be set by a Cloudflare team member, so committing the asset is how they receive it.