Repository navigation
Add the social preview card and Open Graph tags so shared repository and docs links show a project card - #47
Merged
Merged
Conversation
…and docs links show a project card
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
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.
Makes a shared link to the repository or the docs show a project card.
.github/social-preview.png: the card in the organization's house style (logo, "The maintained fork of MosaicML Streaming", install line, chips). The GitHub social preview itself is set in the repository settings, which has no API.sphinxext-opengraphindocs/source/conf.pywithogp_site_url,ogp_site_name,ogp_imagepointing at the committed card, andogp_description_length; the extension is added to thedocsextra insetup.py, which the Read the Docs build installs.The Read the Docs pull request preview verifies the docs build; the tags can be checked on the preview with
grep 'og:image'.