Skip to content

feat: add HowTo JSON-LD schema to quickstart guides#1164

Closed
kevlil83 wants to merge 2 commits into
mainfrom
feat/quickstart-schema
Closed

feat: add HowTo JSON-LD schema to quickstart guides#1164
kevlil83 wants to merge 2 commits into
mainfrom
feat/quickstart-schema

Conversation

@kevlil83
Copy link
Copy Markdown
Contributor

Summary

  • Adds main/snippets/JsonLd.jsx — a minimal reusable snippet that renders a <script type="application/ld+json"> tag from a data prop.
  • Applies HowTo structured data to 39 quickstart index.mdx pages across native, SPA, webapp, and backend platforms, exposing each guide's steps as machine-readable HowToStep entries.

Why

Improves discoverability in AI-powered search (ChatGPT, Perplexity, Google AI Overviews, Gemini) and in traditional search rich results. Quickstarts are our highest-intent entry pages — making their step structure machine-readable helps these surfaces cite and summarize them accurately.

Scope

  • Pages touched: 19 native, 7 SPA, 13 webapp — see main/docs/quickstart/**/index.mdx
  • One new snippet: main/snippets/JsonLd.jsx
  • No navigation or docs.json changes
  • No production JS/CSS bundle rebuild needed — JsonLd is an MDX snippet, not a UI library component

Notes for reviewers

  • The Go backend quickstart (main/docs/quickstart/backend/golang/index.mdx) had a merge conflict because it was recently reorganized on main. Schema was placed after imports and before export const envSnippet to match the pattern used in the other 38 files (see nextjs/index.mdx for reference). Step names in that file's schema may need a second pass to align with the new single-file golang structure — flagging for follow-up.
  • The <JsonLd /> component emits a raw <script> element via dangerouslySetInnerHTML; the JSON is serialized once at render time.

Test plan

  • cd main && mint dev renders without new errors
  • View source on several quickstart pages and confirm one application/ld+json block is present with valid JSON
  • Paste rendered JSON into https://validator.schema.org — no errors on a sample of 3-5 pages
  • Spot-check: /docs/quickstart/webapp/nextjs, /docs/quickstart/backend/golang, /docs/quickstart/spa/react, /docs/quickstart/native/ios-swift

@kevlil83 kevlil83 requested review from a team as code owners May 12, 2026 18:30
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 12, 2026

Summary

Status Count
🔍 Total 329
✅ Successful 212
⏳ Timeouts 0
🔀 Redirected 37
👻 Excluded 75
❓ Unknown 0
🚫 Errors 5
⛔ Unsupported 0

Errors per input

Errors in main/docs/quickstart/spa/angular/index.mdx

Errors in main/docs/quickstart/spa/react/index.mdx

Errors in main/docs/quickstart/spa/vuejs/index.mdx

Errors in main/docs/quickstart/webapp/nextjs/index.mdx

Errors in main/docs/quickstart/webapp/nuxt/index.mdx

Redirects per input

Redirects in main/docs/quickstart/backend/aspnet-core-webapi/index.mdx

Redirects in main/docs/quickstart/backend/fastapi/index.mdx

Redirects in main/docs/quickstart/backend/fastify/index.mdx

Redirects in main/docs/quickstart/backend/golang/index.mdx

Redirects in main/docs/quickstart/backend/python/index.mdx

Redirects in main/docs/quickstart/native/android-facebook-login/index.mdx

Redirects in main/docs/quickstart/native/android/index.mdx

Redirects in main/docs/quickstart/native/ionic-angular/index.mdx

Redirects in main/docs/quickstart/native/ionic-react/index.mdx

Redirects in main/docs/quickstart/native/ionic-vue/index.mdx

Redirects in main/docs/quickstart/native/ios-swift-facebook-login/index.mdx

Redirects in main/docs/quickstart/native/maui/index.mdx

Redirects in main/docs/quickstart/native/react-native-expo/index.mdx

Redirects in main/docs/quickstart/native/react-native/index.mdx

Redirects in main/docs/quickstart/native/wpf-winforms/index.mdx

Redirects in main/docs/quickstart/spa/flutter/index.mdx

Redirects in main/docs/quickstart/spa/svelte/index.mdx

Redirects in main/docs/quickstart/spa/vanillajs/index.mdx

Redirects in main/docs/quickstart/spa/vuejs/index.mdx

Redirects in main/docs/quickstart/webapp/aspnet-core-blazor-server/index.mdx

Redirects in main/docs/quickstart/webapp/aspnet-core/index.mdx

Redirects in main/docs/quickstart/webapp/express/index.mdx

Redirects in main/docs/quickstart/webapp/fastapi/index.mdx

Redirects in main/docs/quickstart/webapp/fastify/index.mdx

Redirects in main/docs/quickstart/webapp/nuxt/index.mdx

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 12, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
auth0 🟢 Ready View Preview May 12, 2026, 6:44 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Adds a reusable JsonLd snippet and HowTo structured data to 39 quickstart
index pages across native, SPA, webapp, and backend platforms. Improves
discoverability in AI search (ChatGPT, Perplexity, Google AI Overviews)
and in traditional search rich results by exposing each quickstart's steps
as machine-readable HowToStep entries.
Replaces three pre-existing 404 links and one auth-gated 302 flagged by
the Lychee link checker:

- golang: Production Checklist -> Production Readiness Checks
  (/deploy-monitor/pre-deployment-checks/production-checks-best-practices)
- express: Add Authorization -> /manage-users/access-control/rbac
- express: Call Protected APIs -> /secure/tokens/access-tokens/get-access-tokens
- java: drop Support Center link (requires auth, 302s); keep Community
@kevlil83
Copy link
Copy Markdown
Contributor Author

Closing in favor of a fresh PR with squashed history. New PR link will be posted here.

@kevlil83 kevlil83 closed this May 12, 2026
@kevlil83 kevlil83 deleted the feat/quickstart-schema branch May 12, 2026 21:07
@kevlil83
Copy link
Copy Markdown
Contributor Author

Superseded by #1165 (same content, squashed to a single commit).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant