feat: add HowTo JSON-LD schema to quickstart guides#1164
Closed
kevlil83 wants to merge 2 commits into
Closed
Conversation
Summary
Errors per inputErrors 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 inputRedirects 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
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 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.
c79c068 to
9da2d26
Compare
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
Contributor
Author
|
Closing in favor of a fresh PR with squashed history. New PR link will be posted here. |
5 tasks
Contributor
Author
|
Superseded by #1165 (same content, squashed to a single commit). |
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
main/snippets/JsonLd.jsx— a minimal reusable snippet that renders a<script type="application/ld+json">tag from a data prop.HowTostructured data to 39 quickstartindex.mdxpages across native, SPA, webapp, and backend platforms, exposing each guide's steps as machine-readableHowToStepentries.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
main/docs/quickstart/**/index.mdxmain/snippets/JsonLd.jsxJsonLdis an MDX snippet, not a UI library componentNotes for reviewers
main/docs/quickstart/backend/golang/index.mdx) had a merge conflict because it was recently reorganized on main. Schema was placed after imports and beforeexport const envSnippetto match the pattern used in the other 38 files (seenextjs/index.mdxfor 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.<JsonLd />component emits a raw<script>element viadangerouslySetInnerHTML; the JSON is serialized once at render time.Test plan
cd main && mint devrenders without new errorsapplication/ld+jsonblock is present with valid JSON/docs/quickstart/webapp/nextjs,/docs/quickstart/backend/golang,/docs/quickstart/spa/react,/docs/quickstart/native/ios-swift