Conversation
…JSON-LD Transforms :::faq blocks (### question + answer) into a Radix accordion and emits schema.org FAQPage structured data at compile time. LLM-served markdown (getLLMText) strips the directive fences so AI crawlers get clean question/answer sections.
163 reviewed Q&As across 47 pages targeting search and AI answer-engine discoverability. Answers are grounded in page content; CAPTCHA support list fact-checked against the steel-main codebase.
The Radix Accordion.Header renders an <h3>, and app/global.css sets h3 to 20px; the trigger button had no explicit font-size and inherited it. Pin text-base (16px) on the trigger so it matches the docs body instead of the heading size.
Contributor
|
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
Adds short FAQ sections (3–5 Q&As each) to 47 docs pages — 163 reviewed Q&As total — plus the
:::faqMDX directive andFAQPageJSON-LD that render them.Why
Two goals: SEO and AI answer-engine discoverability (ChatGPT search, Perplexity, AI Overviews). Answer engines extract and cite content already shaped as question → direct answer, and the docs' most-searched facts currently live in tables that extract poorly (e.g. "how long can a Steel session run?" is buried in a pricing-table cell). Restating those facts as prose Q&As makes them citable. The existing AI pipeline compounds this: FAQs flow into the
/llms.mdx/*routes and the markdown-negotiated responses served to GPTBot/PerplexityBot/ClaudeBot automatically.How it works
:::faqdirective (lib/remark-custom-directives.ts) — parses### Question+ answer blocks at build time into a Radix accordion (components/faq.tsx) and emits schema.orgFAQPageJSON-LD. Verified in the production build output (valid JSON, correct shape).lib/get-llm-text.ts) — strips the:::faqfences so AI crawlers get clean### Question / answersections without directive syntax.steel-maincodebase.Scope
tests/), newbun run testscript.overview/stealth/captcha-solving.mdxbody claims Amazon AWS WAF is supported and omits hCaptcha/slider — but the code (ANALYTICS_ONLY_CAPTCHA_TYPESin steel-main) says WAF/DataDome/Imperva/FunCaptcha are detected only, not solved. The page's FAQ now carries the correct list, so the body contradicts its own FAQ until the body is updated.overview/captchas-api/overview.mdxdocuments four task types; the code has six solvable ones — worth confirming what the public API exposes before updating.I left both untouched per scope; flagging for a follow-up.
Notes
chore(faq): add PR preview screenshot) only adds the preview PNG above — safe to drop before merge.bun run lint,bun run validate-links,bun run build, andbun run testall pass.