Add Social Media Preview Image for Ruby LSP Docs #2606
Merged
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
alexcrocha
added
documentation
vinistock
approved these changes
Sep 24, 2024
andyw8
approved these changes
Sep 24, 2024
|
Once it deploys I will run it against https://socialsharepreview.com/ |
|
Before: 
|
|
Not fully working yet, I commented on the internal issue. |
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.
Addresses https://github.com/Shopify/team-ruby-dx/issues/1272
This PR adds social media previews for the Ruby LSP documentation by setting a default image in Jekyll's configuration file.
Motivation
Currently, there is no image preview when sharing the docs on social media. By adding a default image, we can enhance the appearance and engagement of shared links.
Implementation
Added the Ruby LSP icon as the default image to
jekyll/_config.yml. Thejekyll-seo-tagdependency, which is already included in thejust-the-docstheme, was used to handle this. I followed the instructions from the jekyll-seo-tag documentation to set up the default image.