-
Notifications
You must be signed in to change notification settings - Fork 7
Add llms-only FAQ section to home page #6786
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -108,3 +108,27 @@ Build a docs site quickly by importing your existing styling and specs. | |||||
| WCAG 2.1 AA contrast, keyboard navigation, and screen readers | ||||||
| </Card> | ||||||
| </CardGroup> | ||||||
|
|
||||||
| <llms-only> | ||||||
|
|
||||||
| ## Frequently Asked Questions | ||||||
|
|
||||||
| ### What can I build with Fern Docs? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
|
||||||
| 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? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
|
||||||
| Yes. Fern generates API reference pages from OpenAPI, AsyncAPI, gRPC, and OpenRPC specifications, including an interactive API explorer for sending real requests. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶 |
||||||
|
|
||||||
| ### What authentication options does Fern Docs support? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
|
||||||
| Fern Docs supports password protection, SSO, JWT, and OAuth for gating access to your documentation. You can also use role-based access control (RBAC) to show content based on a reader's role. | ||||||
|
|
||||||
| ### Can I add custom code to my Fern docs site? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
|
||||||
| Yes. Fern supports custom CSS, JavaScript, and React components, so you can extend and style your site beyond the built-in theme options. | ||||||
|
|
||||||
| ### Does Fern Docs support multiple languages or localization? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶 |
||||||
| Yes. Fern supports localization, allowing you to ship documentation in multiple languages from a single source repository. | ||||||
|
|
||||||
| ### What analytics integrations does Fern Docs support? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
|
||||||
| Fern Docs integrates with PostHog, Segment, Mixpanel, Google Tag Manager, and other analytics platforms via its analytics configuration. | ||||||
|
|
||||||
| </llms-only> | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -409,3 +409,24 @@ instances: | |||||
|
|
||||||
| This is enough to publish (the CLI will build an empty site). In practice, most teams add `navigation` to define the sidebar, plus basic branding — these are shown in the [Customize your docs](#customize-your-docs) step above. The full list of available fields is in the [site-level settings reference](/learn/docs/configuration/site-level-settings). | ||||||
| </llms-only> | ||||||
|
|
||||||
| <llms-only> | ||||||
|
|
||||||
| ## Frequently Asked Questions | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶 |
||||||
|
|
||||||
| ### How do I get started with Fern Docs? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶 |
||||||
| Install the Fern CLI with `npm install -g fern-api`, run `fern init --docs` to scaffold a project, then run `fern generate --docs` to publish your site. | ||||||
|
|
||||||
| ### What file format does Fern use for documentation pages? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶 |
||||||
| 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? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.HeadingPunctuation> reported by reviewdog 🐶
Suggested change
|
||||||
| 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? | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶 |
||||||
| Yes. Run `fern docs dev` to start a local development server with hot-reloading. You can also generate shareable preview links for pull requests. | ||||||
|
|
||||||
| ### How do I set a custom domain for my Fern docs? | ||||||
| Configure the `url` field under `instances` in `docs.yml` with your desired domain, then set up a CNAME record or reverse proxy pointing to Fern's origin. | ||||||
|
|
||||||
| </llms-only> | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -434,3 +434,27 @@ Fern offers lightning-fast support. If you're a customer, reach out via your ded | |
| - [Email us](mailto:support@buildwithfern.com) | ||
| - [Book a demo](https://buildwithfern.com/book-demo) | ||
| </llms-only> | ||
|
|
||
| <llms-only> | ||
|
|
||
| ## Frequently Asked Questions | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶 |
||
|
|
||
| ### What is Fern? | ||
| Fern is a developer tooling platform that generates SDKs and documentation from your API definition. It supports OpenAPI, AsyncAPI, gRPC, and OpenRPC specs. | ||
|
|
||
| ### What languages does Fern support for SDK generation? | ||
| Fern generates SDKs in TypeScript, Python, Go, Java, C# (.NET), PHP, Ruby, Swift, and Rust. | ||
|
|
||
| ### How does Fern compare to writing SDKs by hand? | ||
| Fern generates idiomatic, production-ready SDKs automatically from your API spec, eliminating the need to write and maintain client libraries manually across multiple languages. | ||
|
|
||
| ### Can I use Fern just for documentation, without SDKs? | ||
| Yes. Fern Docs is a standalone product. You can publish a documentation site from Markdown and an OpenAPI spec without generating any SDKs. | ||
|
|
||
| ### Does Fern support custom domains? | ||
| Yes. You can serve your Fern docs from your own subdomain (e.g. `docs.example.com`) or a subpath (e.g. `example.com/docs`) using a custom domain or reverse proxy setup. | ||
|
|
||
| ### Is Fern open source? | ||
| Fern's CLI and SDK generators are open source on GitHub. The hosted docs platform and dashboard are commercial products. | ||
|
|
||
| </llms-only> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.