Add llms-only FAQ section to home page - #6786
Conversation
7bb24e5 to
9cc5a6e
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| <llms-only> | ||
|
|
||
| ## Frequently Asked Questions |
There was a problem hiding this comment.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| **What is Fern?** |
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'what's' instead of 'What is'.
| **What is Fern?** | |
| **what's Fern?** |
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| **What is Fern?** |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| **What is Fern?** | ||
| Fern is a developer experience platform that generates idiomatic SDKs in multiple programming languages and creates beautiful, interactive API documentation websites from your API definition (OpenAPI, AsyncAPI, gRPC, or OpenRPC). | ||
|
|
||
| **What programming languages does Fern support for SDK generation?** |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| **What programming languages does Fern support for SDK generation?** | ||
| Fern generates SDKs in TypeScript, Python, Go, Java, C# (.NET), PHP, Ruby, Swift, Rust, Kotlin, and C++. | ||
|
|
||
| **Is Fern open source?** |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| **Is Fern open source?** | ||
| Fern's SDK generators and CLI are open source on GitHub. The hosted docs and dashboard are a commercial product with a free tier. | ||
|
|
||
| **How does Fern compare to writing SDKs by hand?** |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| **How does Fern compare to writing SDKs by hand?** | ||
| Fern generates idiomatic, production-ready client libraries automatically from your API spec, eliminating weeks of manual SDK development and keeping all language SDKs in sync as your API evolves. | ||
|
|
||
| **Can I use Fern just for documentation, without generating SDKs?** |
There was a problem hiding this comment.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
| **How does Fern compare to writing SDKs by hand?** | ||
| Fern generates idiomatic, production-ready client libraries automatically from your API spec, eliminating weeks of manual SDK development and keeping all language SDKs in sync as your API evolves. | ||
|
|
||
| **Can I use Fern just for documentation, without generating SDKs?** |
There was a problem hiding this comment.
📝 [vale] <FernStyles.Hedges> reported by reviewdog 🐶
Avoid hedge words and filler like 'just'. Prefer direct statements.
| **How does Fern compare to writing SDKs by hand?** | ||
| Fern generates idiomatic, production-ready client libraries automatically from your API spec, eliminating weeks of manual SDK development and keeping all language SDKs in sync as your API evolves. | ||
|
|
||
| **Can I use Fern just for documentation, without generating SDKs?** |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| **Can I use Fern just for documentation, without generating SDKs?** | ||
| Yes. Fern Docs is a standalone product. You can publish a beautiful, interactive documentation site from Markdown and your API spec without using SDK generation at all. | ||
|
|
||
| **Does Fern support custom domains?** |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| **Does Fern support custom domains?** | ||
| Yes. You can serve your Fern docs from your own subdomain (e.g. `docs.example.com`) or subpath (e.g. `example.com/docs`) using a custom domain or reverse proxy setup. | ||
|
|
||
| **What API specification formats does Fern support?** |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
|
🌿 Preview your docs: https://fern-preview-2026-08-31-fern-ai-d8be69-ef992651.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
9cc5a6e to
1d97807
Compare
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'don't' instead of 'do not'.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'what's' instead of 'What is'.
docs/fern/products/home/pages/welcome.mdx
Line 442 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 442 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 442 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 445 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 445 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 448 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 448 in 1d97807
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 451 in 1d97807
📝 [vale] <FernStyles.Hedges> reported by reviewdog 🐶
Avoid hedge words and filler like 'just'. Prefer direct statements.
docs/fern/products/home/pages/welcome.mdx
Line 451 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 451 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 451 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 454 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 454 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/home/pages/welcome.mdx
Line 457 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/home/pages/welcome.mdx
Line 457 in 1d97807
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
docs/fern/products/sdks/introduction.mdx
Line 294 in 1d97807
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'what's' instead of 'What is'.
docs/fern/products/sdks/introduction.mdx
Line 296 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 296 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 296 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 299 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 299 in 1d97807
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
docs/fern/products/sdks/introduction.mdx
Line 302 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 302 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 302 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 305 in 1d97807
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
docs/fern/products/sdks/introduction.mdx
Line 305 in 1d97807
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
docs/fern/products/sdks/introduction.mdx
Line 308 in 1d97807
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
docs/fern/products/sdks/introduction.mdx
Line 308 in 1d97807
|
|
||
| <llms-only> | ||
|
|
||
| ## Frequently Asked Questions |
There was a problem hiding this comment.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| ### What can I build with Fern Docs? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| ### What can I build with Fern Docs? |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| ### What can I build with Fern Docs? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
| ### What can I build with Fern Docs? | |
| ### What can I build with Fern Docs |
| ### What can I build with Fern Docs? | ||
| Fern Docs lets you build a fully branded developer documentation site with Markdown pages, auto-generated API references, interactive API explorers, changelogs, versioning, and AI-powered search. | ||
|
|
||
| ### Does Fern Docs support API reference generation? |
There was a problem hiding this comment.
🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Use 'API Reference' instead of 'API reference'.
| ### What file format does Fern use for documentation pages? | ||
| Fern uses MDX files (Markdown with JSX support). Pages are stored in the `fern/docs/` folder and referenced from `docs.yml`. | ||
|
|
||
| ### How do I add an API reference to my Fern docs site? |
There was a problem hiding this comment.
🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Use 'API Reference' instead of 'API reference'.
| ### What file format does Fern use for documentation pages? | ||
| Fern uses MDX files (Markdown with JSX support). Pages are stored in the `fern/docs/` folder and referenced from `docs.yml`. | ||
|
|
||
| ### How do I add an API reference to my Fern docs site? |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
| ### What file format does Fern use for documentation pages? | ||
| Fern uses MDX files (Markdown with JSX support). Pages are stored in the `fern/docs/` folder and referenced from `docs.yml`. | ||
|
|
||
| ### How do I add an API reference to my Fern docs site? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Don't use end punctuation in headings.
| ### How do I add an API reference to my Fern docs site? | |
| ### How do I add an API reference to my Fern docs site |
| ### How do I add an API reference to my Fern docs site? | ||
| Add your OpenAPI spec to the fern folder and reference it in `docs.yml` under `navigation` with `- api: "API Reference"`. Fern will generate the reference pages automatically. | ||
|
|
||
| ### Can I preview my Fern docs locally before publishing? |
There was a problem hiding this comment.
📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.
| ### How do I add an API reference to my Fern docs site? | ||
| Add your OpenAPI spec to the fern folder and reference it in `docs.yml` under `navigation` with `- api: "API Reference"`. Fern will generate the reference pages automatically. | ||
|
|
||
| ### Can I preview my Fern docs locally before publishing? |
There was a problem hiding this comment.
📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.
Appended a new
<llms-only>FAQ section to the bottom of the home page (fern/products/home/pages/welcome.mdx, served at /learn/home) with seven SEO-focused Q&A entries covering what Fern is, supported SDK languages and API spec formats, how Fern differs from other SDK generators, Fern Docs capabilities, open-source status, and getting started. No other content on the page was modified.