-
Notifications
You must be signed in to change notification settings - Fork 7
Add llms-only FAQ sections to five high-traffic pages #6795
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] <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 Docs lets you build a complete developer documentation site: write pages in Markdown, generate API references from OpenAPI or other specs, add interactive components, enable AI search with Ask Fern, protect content with authentication and role-based access control, localize into multiple languages, and publish to a custom domain. | ||||||
|
|
||||||
| ### 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] <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 Docs generates interactive API reference pages from OpenAPI, AsyncAPI, gRPC, and OpenRPC specifications. The API Explorer lets readers send real requests directly from the docs with prefilled authentication. | ||||||
|
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 🐶 |
||||||
|
|
||||||
| ### Can I password-protect or restrict access to my 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 🐶 |
||||||
| Yes. Fern Docs supports password protection, SSO, JWT, and OAuth for authentication. Role-based access control (RBAC) lets you show or hide specific content based on each reader's role. | ||||||
|
|
||||||
| ### Does Fern Docs support multiple languages (localization)? | ||||||
| Yes. Fern Docs has built-in localization support, allowing you to ship documentation in multiple languages from a single source repository. | ||||||
|
|
||||||
| ### Can I self-host Fern Docs on my own infrastructure? | ||||||
|
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 Docs supports self-hosting so you can deploy the documentation site on your own servers or cloud infrastructure. | ||||||
|
|
||||||
| ### 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 can forward analytics events to PostHog, Segment, Mixpanel, and other providers. The Fern Dashboard also provides built-in traffic analytics. | ||||||
|
|
||||||
| </llms-only> | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -409,3 +409,27 @@ 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] <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
|
||||||
| Install the Fern CLI with `npm install -g fern-api` or `brew install fern-api`, then run `fern init --docs` to create a new project, or clone the [docs-starter template](https://github.com/fern-api/docs-starter). Configure your organization name in `fern.config.json` and your docs URL in `docs.yml`, then run `fern generate --docs` to publish. | ||||||
|
|
||||||
| ### How long does it take to publish a 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.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 🐶 |
||||||
| Most teams publish their first docs site in under 5 minutes using the starter template. The CLI handles building and deploying automatically. | ||||||
|
|
||||||
| ### Can I preview my Fern docs 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 🐶
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. Run `fern docs dev` to start a local development server with hot-reloading, or run `fern generate --docs --preview` to generate a shareable preview URL you can send to teammates. | ||||||
|
|
||||||
| ### How do I add an API reference to my 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 🐶 |
||||||
| Add your OpenAPI spec to the project (or run `fern init --openapi /path/to/spec.yml`), then reference it in `docs.yml` with `- api: "API Reference"`. Fern will generate interactive API reference pages automatically on the next publish. | ||||||
|
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 🐶 |
||||||
|
|
||||||
| ### How do I publish Fern docs in a CI/CD pipeline? | ||||||
|
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 🐶 |
||||||
| Set the `FERN_TOKEN` environment variable (generate a token with `fern token`) and run `fern generate --docs --no-prompt` to skip the interactive menu. Store the token as a repository secret named `FERN_TOKEN` in GitHub Actions. | ||||||
|
|
||||||
| ### Can non-technical teammates edit Fern docs? | ||||||
| Yes. The Fern Editor is a visual, WYSIWYG editing interface in the Fern Dashboard that lets teammates without Git access write and update documentation pages. | ||||||
|
|
||||||
| </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.