feat: add standard Faq component and convert docs to use it - #5641
Merged
Conversation
rishi-raj-jain
requested review from
andrelandgraf,
danieltprice,
philip and
ruf-io
as code owners
August 26, 2026 05:18
|
@rishi-raj-jain is attempting to deploy a commit to the neondatabase Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
philip
requested changes
Aug 26, 2026
philip
left a comment
philip
left a comment
Collaborator
There was a problem hiding this comment.
Nice! I left a comment, and also process-md-for-llms.js needs a new componentHandlers entry for Faq and FaqItem, for the generated LLM friendly Markdown.
Example preview here and this from the build logs [LLM Processor] Unknown component: <Faq>
Contributor
Author
|
Philip, thank you for the suggestion and I appreciate you teaching me that. I have made the required changes. May you take a look? |
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
2 participants
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.
Why
FAQ sections across the docs were built ad-hoc with
DefinitionList, bare### questionheadings, and**Q:/A:**text which had inconsistent casing and no structured markup. None of them emitted schema.org data, so they weren't eligible for Google FAQ rich results, and collapsed answers weren't reliably crawlable.What
Faq/FaqItemcomponent (src/components/pages/doc/faq/) that renders each answer with native<details>/<summary>and emitsFAQPageschema.org JSON-LD. Answers stay crawlable when collapsed and accept full markdown.content.jsx) and added its styles (doc-content.css).## Frequently asked questions): plans, HIPAA, Azure regions deprecation, AI database versioning, Vercel branch cleanup, and Vercel managed integration.README.md, the component guide, andCLAUDE.md