[PDE-732] feat: add Open Graph image, rewrite README, and clean up unused config for better SEO#8
Open
motunrayokoyejo wants to merge 4 commits into
Open
[PDE-732] feat: add Open Graph image, rewrite README, and clean up unused config for better SEO#8motunrayokoyejo wants to merge 4 commits into
motunrayokoyejo wants to merge 4 commits into
Conversation
✅ Deploy Preview for convoy-playground ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mekilis
approved these changes
Apr 22, 2026
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.
Summary
This PR improves how the playground appears when shared on social platforms and search engines, rewrites the README to properly represent the product, and removes leftover boilerplate from the original project scaffold.
Context
Right now, the playground URL has no preview image. Platforms fall back to a generic blank card, which makes the link look untrustworthy and significantly reduces click-through rates. Also, the README on GitHub is still the default create-next-app template, which gives no information about what the playground actually does and offers no setup guidance for contributors. There are also several dead configuration options and unused files that were left behind from the initial scaffold .
What changed
Open Graph and Twitter Card image
I added a static OG image and referenced it in the metadata in
layout.jsfor both Open Graph and Twitter cards. This means when someone shares the playground link on social platforms, they will now see a branded preview card instead of a blank one. I also addedmax-image-preview: largeandmax-snippet: -1as Googlebot directives so Google can show the full image and longer text snippets in search results, and expanded the keywords list with additional high-intent search terms like "webhook receiver", "webhook url", and "test webhooks online".README rewrite
The default Next.js README has been replaced with a proper product README that explains what the playground does, lists its features, walks through the setup process, documents the required environment variables in a table, describes the tech stack, explains how the app works end-to-end, and outlines the project structure. I also added a
.env.examplefile so new contributors immediately know which environment variables are needed without having to dig through the code.Dead config and file cleanup
I removed
compiler.styledComponents: truefromnext.config.jsbecause there is no styled-components dependency in the project, this was likely carried over from a template. I also removed the unusedPROJECT_TOKENenvironment variable from the same file since it is not referenced anywhere in the codebase. On the file side, I deletedapp/globals.csswhich was never imported (the app usesstyles.scssas its stylesheet), deleted the Sentry onboarding example page and API route (pages/sentry-example-page.jsandpages/api/sentry-example-api.js) which were stock boilerplate from the Sentry setup wizard, and deletedpublic/vercel.svgwhich was an unused default asset from create-next-app.