docs: overhaul README with badges, a tool gallery, and live links#15
Merged
Conversation
Give the repo a proper front page: - badge row: live site, license, CI, GitHub stars, last commit, made-by - a hero image and a 2x2 gallery of the four tools, each linking to the live tool, reusing the generated per-page Open Graph cards (committed under .github/assets/) - a table of contents, and a live link on every tool in the Tools section - refreshed Stack / Add a tool / Deploy notes to cover the OG renderer, the JSON-LD builders, and the GITHUB_REPO constant Every tool description was checked against the code.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
Turns the README into a proper repo front page and reuses the per-page social cards shipped earlier in this plan.
.github/assets/.lib/og.tsx), the JSON-LD builders (lib/jsonLd.ts), and theGITHUB_REPOconstant a fork needs to update.Why the OG cards are committed (not hotlinked)
The per-tool OG routes carry a content hash in their URL (
/json-formatter/opengraph-image-1f12ql), so they aren't stable to hotlink. Committing the five PNGs makes the README render offline, in the PR diff, and even if the site is down. A note in the README points atlib/og.tsxto regenerate them if a tool's copy changes.Deliberately not included
Verification
lib/*-utils.ts, the OG/JSON-LD registry wiring, the Add-a-tool steps, the project-layout paths, Node 22 vs.nvmrc). Result: no issues.Final PR in the SEO / discoverability plan (per-page social images → structured data → on-site GitHub star count → this).