seo: structured data, indexable provider/FAQ content, metadata overhaul - #10
seo: structured data, indexable provider/FAQ content, metadata overhaul#10leoisadev1 wants to merge 1 commit into
Conversation
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile SummaryThis change improves the Sandbox SDK documentation site’s search presentation and discoverability by centralizing metadata, adding structured data, expanding provider and FAQ content, generating page-specific social metadata, and removing an obsolete sitemap entry. The production static export built successfully. Browser checks confirmed that all seven homepage provider links resolve, homepage and documentation structured data is parseable, documentation canonical and social-image URLs resolve, and the sitemap includes current provider documentation routes while excluding the retired No product-facing defects were found. The change is safe to merge. Confidence Score: 5/5Safe to merge: the changed documentation site builds and its newly added navigation, metadata, structured data, social image, and sitemap behavior were exercised successfully. The final review contains no independent findings. Production-export browser checks covered the primary user-visible paths introduced by the change. Files Needing Attention: No files require follow-up based on the completed checks.
What T-Rex did
Reviews (1): Last reviewed commit: "seo: structured data, richer metadata, p..." | Re-trigger Greptile |
Summary
We rank behind Cloudflare's "Sandbox SDK" docs for the query
sandbox sdk. The site gave crawlers very little to work with: the homepage was an animated landing page whose only text was "One sandbox API. Every provider." (the phrase "Sandbox SDK" appeared nowhere in the body), there was no structured data at all, and/providerswas in the sitemap while returning 404.This adds the on-page substance and machine-readable signals, without changing any product claims.
New
src/lib/seo.tscentralizes the SEO surface — canonical URLs, tagline, short meta description vs. long schema description, keywords, the FAQ corpus, and schema builders:Structured data via a small
<JsonLd data={...} />component (escapes<before injecting). Root layout emitsOrganization+WebSite+SoftwareSourceCode; the homepage emitsFAQPage; every docs page emitsTechArticle+ aBreadcrumbListbuilt from its slug, resolving each segment's real title throughsource.getPage()and falling back to title-cased slug.Homepage gains two indexable sections plus a visible
Sandbox SDKkicker above the H1 and a keyword-bearing intro paragraph:/docs/providers/*faqsthat back theFAQPageschemaPreviously the homepage linked out to almost nothing; these are the internal links that let PageRank reach the docs tree.
Metadata:
metadataBase, a title template (%s · Sandbox SDK), authors/publisher/category, explicitrobots+googleBot(max-snippet: -1,max-image-preview: large), and fuller OG/Twitter. Docs pages now use their own generated OG image (getPageImage(page)) instead of the one sharedog-image.png.Fixes: dropped the dead
/providersentry from the sitemap (curl→ 404; the real route is/docs/providers), andsitemap.tsnow importssiteUrlinstead of hardcoding the origin.Off-site: README (root and published package) now open with a sentence that actually names and defines the product, and
packages/sdk/package.jsongains a descriptivedescription+keywordsfor npm search.Verified
lint,typecheck, andbuildpass, and checked the static export: canonical URLs are per-page (not all/), the emitted@types areOrganization/WebSite/SoftwareSourceCode/FAQPage, docs pages carryBreadcrumbListand per-pageog:image, and/providersis gone fromsitemap.xml.Link to Devin session: https://app.devin.ai/sessions/95f7fbaac03841f3ae947ea53480fd32
Requested by: @leoisadev1