docs: keep the social preview image in the repo - #34
Merged
Conversation
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.
The 1280×640 social preview is uploaded to GitHub and live, but GitHub stores it on its own side — there is no API to read it back and no copy in the repository. Committing it means a future variant starts from the real file rather than a screenshot.
Lives at
docs/assets/social-preview.pngwith a shortREADME.mdalongside recording two things that are easy to get wrong:icon.pngships inside the.nupkg, so replacing it only reaches users in a new package version. The social preview lives on GitHub's side and updates every existing link the moment it is uploaded. Same-looking assets, opposite update semantics.ESlettermark reads as EmmaSharper rather than Emma, which is the point: a bareEinvites the misreading that this is a first-party client.Also notes that uploading is UI-only (Settings → General → Social preview), since that surprised me when I went looking for an endpoint.
65 KB. No build or packaging impact — it sits under
docs/, outside anythingdotnet packtouches.