Skip to content

docs(seo): add FAQPage JSON-LD to 2 FAQ pages#1249

Open
ekline[bot] wants to merge 1 commit into
mainfrom
docs/faq-jsonld/add-faqpage-schema
Open

docs(seo): add FAQPage JSON-LD to 2 FAQ pages#1249
ekline[bot] wants to merge 1 commit into
mainfrom
docs/faq-jsonld/add-faqpage-schema

Conversation

@ekline
Copy link
Copy Markdown
Contributor

@ekline ekline Bot commented May 15, 2026

Summary

Adds FAQPage JSON-LD structured data on 2 of 2 FAQ pages. Helps AI assistants (ChatGPT, Perplexity, Gemini, Claude), Knowledge Panels, and site search understand your FAQs.

Eligibility

DOES NOT QUALIFY for Google FAQ rich snippets. Since August 2023, Google restricts FAQ rich results to well-known government and health sites. However, the structured data still provides real value:

  • AI assistants (ChatGPT, Perplexity, Gemini, Claude) use JSON-LD to surface accurate answers from your FAQ pages
  • Knowledge Panels and Google's AI Overviews reference structured FAQ data
  • Site search (Algolia, Coveo, etc.) can parse JSON-LD for improved FAQ indexing

Coverage

Metric Count
FAQ pages found 2
Changed in this PR 2
Deferred (past cap) 0
Already valid 0
Unsupported 0

No files deferred — full coverage achieved in this run.

Pages changed

Path Extension Action Q&A count
src/content/reference/faqs.mdx .mdx add 10
src/content/admin/billing.mdx .mdx add 7

Framework and strategy

  • Framework: Docusaurus 3 (detected via docusaurus.config.js)
  • Strategy: Inject <script type="application/ld+json"> inside <Head> from @docusaurus/Head (Docusaurus .mdx matrix row)
  • Both files are .mdx — no rename needed

Reviewer checklist

  • Build the docs locally (yarn build) and view each affected page
  • Confirm <script type="application/ld+json"> is in the rendered HTML
  • After deploy, run the live URL through Google's Rich Results Test (https://search.google.com/test/rich-results)
  • Validate the JSON-LD payload at https://validator.schema.org/
  • AI-citation spot check: ask ChatGPT or Perplexity one of the FAQ questions and confirm the model reaches the page
  • Submit the page for re-indexing in Google Search Console if rich results are urgent

Rollback

To revert, remove the <Head> import and the <Head><script type="application/ld+json">...</script></Head> block from each file and re-deploy.

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>

Add FAQPage structured data (JSON-LD) to the main FAQ page and the
billing FAQ section. This helps AI assistants, Knowledge Panels, and
site search parse and surface FAQ content accurately.

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>

Signed-off-by: ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 15, 2026

Deploy Preview for okteto-docs ready!

Name Link
🔨 Latest commit d724aa7
🔍 Latest deploy log https://app.netlify.com/projects/okteto-docs/deploys/6a078e77df598b0008e47aa3
😎 Deploy Preview https://deploy-preview-1249--okteto-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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.

0 participants