Skip to content

Add llms-only FAQ sections to high-traffic docs pages - #6761

Draft
fern-api[bot] wants to merge 1 commit into
mainfrom
2026-08-26-fern-ai-1fb7a4-3ef2079e
Draft

Add llms-only FAQ sections to high-traffic docs pages#6761
fern-api[bot] wants to merge 1 commit into
mainfrom
2026-08-26-fern-ai-1fb7a4-3ef2079e

Conversation

@fern-api

@fern-api fern-api Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Added an AI-only <llms-only> "Frequently Asked Questions" block at the bottom of 23 of the highest-traffic pages across Docs getting started, SDKs overview, AI features (AI overview, MCP server, llms.txt, Ask Fern, Fern Agent), site-level settings, OpenAPI overview, the CLI reference, writing content (Fern Editor, Markdown basics, components overview), self-hosted, and custom domain setup. Each FAQ answers real search-driven questions in Q&A format, grounded strictly in what those pages (and their linked references) already document, so the content is hidden from human readers and search but served through llms.txt and each page's .md endpoint. No existing content, frontmatter, or navigation was changed; fern check reports no new errors and Vale flags no new errors relative to main.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I upgrade the Fern CLI?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the `fern generate --docs` command?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I preview my docs locally before publishing?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I preview my docs locally before publishing?**


📝 [vale] <FernStyles.Acronyms> reported by reviewdog 🐶
'WSL' has no definition.

A: `fern docs dev` runs a local development server with hot reloading; pass `--port` to choose the port. On Windows it requires long path support enabled, or WSL.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I share a preview with my team?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I share a preview with my team?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I manage existing previews?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I manage existing previews?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I check for broken links?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I check for broken links?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I validate my MDX?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I validate my MDX?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I connect a coding agent to Fern over MCP?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I connect a coding agent to Fern over MCP?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What does `fern check` do?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does `fern check` check my live site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I upgrade the Fern CLI?**


⚠️ [vale] <FernStyles.Current> reported by reviewdog 🐶
Avoid time-relative terms like 'latest' that become outdated

A: `fern upgrade` sets `fern.config.json` to the latest allowed version and moves generators to their minimum-compatible versions. Use `--version` for a specific release, `--from` when version inference is wrong, and `--yes` in non-interactive environments. If your organization has a CLI version policy, the highest version the policy allows wins.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: `fern upgrade` sets `fern.config.json` to the latest allowed version and moves generators to their minimum-compatible versions. Use `--version` for a specific release, `--from` when version inference is wrong, and `--yes` in non-interactive environments. If your organization has a CLI version policy, the highest version the policy allows wins.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: What's `fern init` and when do I use it?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's `fern init` and when do I use it?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I authenticate the CLI?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I authenticate the CLI?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I get an OpenAPI spec out of Fern?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I get an OpenAPI spec out of Fern?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I pull the latest version of my spec?**


⚠️ [vale] <FernStyles.Current> reported by reviewdog 🐶
Avoid time-relative terms like 'latest' that become outdated

**Q: How do I pull the latest version of my spec?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I pull the latest version of my spec?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I pin one CLI version for my whole organization?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I pin one CLI version for my whole organization?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What does `fern generate` do?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I generate only one SDK?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: `fern generate --group <group>`, using a group name or an alias defined in `generators.yml`. In multi-API projects, add `--api <name>` matching the folder in `fern/apis/`.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I preview an SDK locally before publishing?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I preview an SDK locally before publishing?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I generate SDKs on my own machine?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: `fern generate --local` runs generation in Docker on your infrastructure, so a Docker daemon must be running. It requires no login and isn't rate limited.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I set the SDK version?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I set the SDK version?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I run generation in CI without prompts?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I run generation in CI without prompts?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I build a distributable package without publishing to a registry?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I build a distributable package without publishing to a registry?**


📝 [vale] <FernStyles.Hedges> reported by reviewdog 🐶
Avoid hedge words and filler like 'just'. Prefer direct statements.

A: `fern generate --package` builds an artifact (npm tarball, wheel, JAR, NuGet package, gem, Composer archive, crate, or Go source zip) into a `fern-dist/` folder for every `local-file-system` output. `--package-mode docker` runs the toolchains in containers, and `--package-only` keeps just the artifact.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What are the Replay commands for?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's Fern Writer and how does it relate to Fern Agent?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What can Fern Agent do?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I use Fern Agent to generate documentation?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Describe the change in the Dashboard chat panel, in a Slack channel where `@Fern` has been added, or through your coding agent over MCP. It reads your docs repository, makes the change, and delivers it as a pull request — or iterates live in the [visual editor](/learn/docs/writing-content/fern-editor).


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can Fern Agent update existing documentation pages?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does Fern Agent work with the visual editor?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What are the requirements?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Is my data used to train AI models?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's `llms.txt` and why does Fern generate it?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I view my site's `llms.txt` file?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Fetch `/llms.txt` on your docs domain. It's available at any level of the hierarchy, so `/docs/llms.txt` and `/docs/ai-features/llms.txt` work too. To see what an agent gets for a single page, append `.md` or `.mdx` to the page URL.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.


📝 [vale] <Microsoft.URLFormat> reported by reviewdog 🐶
Use 'of' (not 'for') to describe the relationship of the word URL to a resource.

A: A one-sentence description and URL for each page, taken from the page's `description` frontmatter (falling back to `subtitle`), plus links to your OpenAPI and AsyncAPI specifications when your site documents endpoints or WebSocket channels.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I exclude a page from `llms.txt`?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add content that only AI agents see?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Yes. Point `agents.llms-txt` in `docs.yml` at a file relative to `docs.yml`. It's served at the root `/llms.txt`; nested paths keep using the generated output.


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the Fern MCP server and how does it work?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I enable the MCP server for my Fern docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I enable the MCP server for my Fern docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can AI coding assistants like Claude or Cursor use my docs?**


⚠️ [vale] <Microsoft.UIVerbs> reported by reviewdog 🐶
Use 'select' instead of the input-specific verb 'click'.

A: Yes. On sites with Ask Fern, the **Connect to Claude Code** and **Connect to Cursor** page actions register the server in one click. Other clients (Claude Desktop, Windsurf, VS Code) add the server URL to their MCP configuration directly.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do MCP clients authenticate on a private docs site?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I disable the MCP server?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I disable the MCP server?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the difference between this server and Fern's own MCP server?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What if an agent can't use MCP?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What AI features does Fern Docs include?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Which AI features are on by default?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Do AI features cost extra?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can AI coding assistants like Claude or Cursor use my Fern docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's Fern Agent and how does it help write documentation?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I enable the Ask Fern AI chat widget on my docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I enable the Ask Fern AI chat widget on my docs site?**


⚠️ [vale] <Microsoft.UIVerbs> reported by reviewdog 🐶
Use 'select' instead of the input-specific verb 'click'.

A: Open the [Fern Dashboard](https://dashboard.buildwithfern.com/), go to **Settings**, and click **Enable** on the Ask AI card. Enabling triggers a reindex of your content, after which the side panel appears on your site. The `ai-search` key in `docs.yml` configures Ask Fern but doesn't turn it on.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I customize the Ask Fern system prompt?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I customize the Ask Fern system prompt?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What data does Ask Fern use to answer questions?**


📝 [vale] <Microsoft.OxfordComma> reported by reviewdog 🐶
Use the Oxford comma in ', with answers generated by Claude and returned with citations.'.

A: Your documentation pages and Fern-generated SDK code, indexed as vector embeddings and retrieved per question (RAG), with answers generated by Claude and returned with citations. You can index additional websites and documents through `ai-search.datasources`.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I configure the verbosity or tone of Ask Fern responses?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I configure the verbosity or tone of Ask Fern responses?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does Ask Fern support multiple languages?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I view Ask Fern conversation analytics?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: In the Fern Dashboard: conversations per day, individual conversation drill-down, CSV export, and a resolution rate for the last week, month, or year. Query logs are retained indefinitely unless you set a retention period (1–3650 days) on the **Query log retention** card.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does Ask Fern respect access control?**


📝 [vale] <Microsoft.OxfordComma> reported by reviewdog 🐶
Use the Oxford comma in ', down to individual pages and conditional blocks.'.

A: Yes. It applies your [RBAC](/learn/docs/authentication/features/rbac) settings, so readers only get answers from content their roles allow, down to individual pages and conditional blocks.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I put Ask Fern somewhere other than my docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I put Ask Fern somewhere other than my docs site?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What built-in components does Fern Docs provide?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I use the `Card`, `CardGroup`, `Callout`, and `Steps` components?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I use the `Card`, `CardGroup`, `Callout`, and `Steps` components?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I create custom MDX components in Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I create custom MDX components in Fern Docs?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I embed a code block with tabs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I embed a code block with tabs?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Is there an AskAIChat component I can embed?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Is there an AskAIChat component I can embed?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Do these components work in Fern Editor?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What Markdown features does Fern Docs support?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.


📝 [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.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.


📝 [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.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I add images, videos, and GIFs to Fern Docs pages?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add images, videos, and GIFs to Fern Docs pages?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Store them alongside your content and reference them with file-relative paths. See [Images, videos, and embeds](/learn/docs/writing-content/markdown-media).


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I add code blocks with syntax highlighting?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add code blocks with syntax highlighting?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I add callouts, warnings, and notes?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add callouts, warnings, and notes?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I access the Fern visual editor?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I access the Fern visual editor?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does the Fern editor support GitLab?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can multiple people edit docs at the same time?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I trigger a deployment from the Fern editor?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I trigger a deployment from the Fern editor?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does the Fern editor support MDX components?**


⚠️ [vale] <FernStyles.Current> reported by reviewdog 🐶
Avoid time-relative terms like 'soon' that become outdated

A: Many of them. Accordions, accordion groups, buttons, callouts, cards, card groups, code blocks, embeds, endpoint request/response/schema snippets, parameter fields, steps, tables, tabs, and tooltips can be created and edited from the UI; asides, frames, icons, and sticky tables are marked coming soon. You can also switch to dev mode to edit the source directly.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.


⚠️ [vale] <FernStyles.Current> reported by reviewdog 🐶
Avoid time-relative terms like 'soon' that become outdated

A: Modern Chromium browsers on desktop. Mobile editing and other browsers are listed as coming soon.


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's Fern Docs and how does it differ from other documentation tools?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How does Fern generate documentation from an API definition?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does Fern support both API Reference docs and hand-written Markdown pages?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I use Fern Docs without using Fern SDKs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I use Fern Docs without using Fern SDKs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What file formats does Fern Docs support for API definitions?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I get started with Fern Docs for the first time?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Install the CLI (`npm install -g fern-api`), create a `fern` folder from the [starter template](https://github.com/fern-api/docs-starter) or with `fern init --docs`, preview with `fern docs dev`, then publish with `fern generate --docs`. The [Docs quickstart](/learn/docs/getting-started/quickstart) covers each step.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Is Fern Docs open source?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What hosting options does Fern Docs support?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How does Fern convert an OpenAPI spec into documentation?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the Fern CLI and how does it work?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How does Fern handle versioning of documentation?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the relationship between the `fern/` folder and the docs output?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How does Fern keep docs in sync with API changes?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Do I have to edit files in Git to update my docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Do I have to edit files in Git to update my docs?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What files are required in the `fern` folder?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I add multiple API definitions to one Fern project?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add multiple API definitions to one Fern project?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Where do I put my OpenAPI spec in the `fern` folder?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Where do I put my OpenAPI spec in the `fern` folder?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Why isn't my new page showing up?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I publish my first Fern docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the `fern generate --docs` command?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: It builds your docs — Markdown, media, `docs.yml` settings, and any API definition — and publishes the result to the URL in `docs.yml`. Add `--preview` to publish to a temporary preview URL instead of production, and `--no-prompt` to skip the interactive confirmation in CI.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I preview my docs locally before publishing?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I preview my docs locally before publishing?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's a `docs.yml` file and what does it configure?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I connect my GitHub repository to Fern Docs?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Install the [Fern GitHub app](https://github.com/apps/fern-api) and [connect the repository](/learn/dashboard/configuration/github-repo) in the [Fern Dashboard](https://dashboard.buildwithfern.com/). The Dashboard also manages organization members and your CLI version — there are no CLI equivalents for those tasks.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I use Fern Docs with an existing OpenAPI spec?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I use Fern Docs with an existing OpenAPI spec?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How long does it take to publish docs with Fern?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I configure the navigation in Fern Docs?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: In the `navigation` key of `docs.yml` (or a product YAML file), where you list `page`, `section`, `api`, `changelog`, and `link` entries in the order they should appear. See [Navigation](/learn/docs/configuration/navigation).


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I add tabs or sections to my docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add tabs or sections to my docs site?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I set a custom logo, colors, and fonts in Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I set a custom logo, colors, and fonts in Fern Docs?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I add a custom domain to my Fern docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add a custom domain to my Fern docs site?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I configure redirects in Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I configure redirects in Fern Docs?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I enable or disable the search bar?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I enable or disable the search bar?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I add navbar links to my docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I add navbar links to my docs site?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I set up versioning in Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I set up versioning in Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the difference between an instance and a custom domain?**


📝 [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.

**Q: How do I set up a custom domain for my Fern docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I set up a custom domain for my Fern docs site?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I use a subdomain like `docs.mycompany.com` with Fern?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Yes. This is the simplest setup: a CNAME record for the subdomain pointing at the value Fern gives you, plus the TXT record for domain verification. If you use Cloudflare, make sure the record isn't proxied.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I use a subpath like `mycompany.com/docs` with Fern?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I use a subpath like `mycompany.com/docs` with Fern?**


📝 [vale] <Microsoft.OxfordComma> reported by reviewdog 🐶
Use the Oxford comma in ', on the Team plan and above.'.

A: Yes, on the Team plan and above. Append the subpath to both `url` and `custom-domain` in `docs.yml` — they must share the same basepath, or `fern check` and publishing fail — and set up a [reverse proxy](/learn/docs/preview-publish/reverse-proxy) that forwards requests to Fern's origin with the `x-fern-host` header. A subpath can't be routed with DNS alone.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I serve docs from my root domain?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I serve docs from my root domain?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I configure DNS for my Fern docs custom domain?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: In your registrar's DNS settings, using the records Fern sends you: a CNAME (subdomain or `www`), an A record for an apex domain, and a TXT record for verification.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How long does it take for a custom domain to go live?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does Fern support SSL/HTTPS for custom domains?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can one docs site serve several domains?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I self-host Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I self-host Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What are the requirements for self-hosting Fern Docs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How does self-hosted Fern Docs differ from the cloud-hosted version?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What features are available in self-hosted mode?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What isn't available when self-hosting?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I monitor a self-hosted deployment?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I monitor a self-hosted deployment?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I generate my first SDK with Fern?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

A: Install the CLI, run `fern init` (optionally with `--openapi <path or URL>`), then run `fern generate`. The default configuration produces a TypeScript SDK in `sdks/typescript`.


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: What's `generators.yml` and how do I configure it?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's `generators.yml` and how do I configure it?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I run `fern generate` to produce an SDK?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I run `fern generate` to produce an SDK?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I preview an SDK locally before publishing?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I preview an SDK locally before publishing?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I set up GitHub Actions to auto-publish my SDK?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I set up GitHub Actions to auto-publish my SDK?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Where does the generated SDK go?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: What happens when I run `fern generate`?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Do I need Docker installed to generate SDKs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Do I need Docker installed to generate SDKs?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can SDK generation run on my own infrastructure?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Why did I only get partial SDK files?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Why did I only get partial SDK files?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Are there limits on how often I can generate?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Are there limits on how often I can generate?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Does generation require authentication?**


📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'Frequently Asked Questions' should use sentence-style capitalization.

## Frequently Asked Questions


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What programming languages does Fern support for SDK generation?**


📝 [vale] <FernStyles.Adverbs> reported by reviewdog 🐶
Remove 'generally' if it's not important to the meaning of the statement.

A: TypeScript, Python, Go, Java, .NET (C#), PHP, Ruby, Swift, and Rust are generally available. C++ and Kotlin are available by [request](https://buildwithfern.com/book-demo?type=language-request).


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How does Fern generate SDKs from an OpenAPI spec?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do Fern-generated SDKs compare to other SDK generators?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Do Fern SDKs support pagination, retries, and OAuth automatically?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: Can I customize the generated SDK code?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: Can I customize the generated SDK code?**


📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: How do I publish a Fern SDK to npm, PyPI, or Maven?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I publish a Fern SDK to npm, PyPI, or Maven?**


📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's the difference between Fern SDKs and hand-written SDKs?**


<llms-only>

## Frequently Asked Questions

Copy link
Copy Markdown
Contributor

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.


## Frequently Asked Questions

**Q: How do I use an OpenAPI spec with Fern?**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.


## Frequently Asked Questions

**Q: How do I use an OpenAPI spec with Fern?**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: How do I use an OpenAPI spec with Fern?**
A: Run `fern init --openapi ./path/to/openapi` (a local file or a URL) to create a `fern` folder that references your spec, then generate docs with `fern generate --docs` or SDKs with `fern generate`.

**Q: Does Fern support OpenAPI 3.0 and 3.1?**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

A: Run `fern init --openapi ./path/to/openapi` (a local file or a URL) to create a `fern` folder that references your spec, then generate docs with `fern generate --docs` or SDKs with `fern generate`.

**Q: Does Fern support OpenAPI 3.0 and 3.1?**
A: Yes. Fern is compatible with the latest OpenAPI release (currently v3.1.1) and reads specs written in earlier 3.x versions, in either YAML or JSON.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] <FernStyles.Current> reported by reviewdog 🐶
Avoid time-relative terms like 'latest' that become outdated

A: It runs SDK generation for the generator groups in `generators.yml`. Add `--group <name>` for one group, `--preview` to generate into a local `.preview/` folder, and `--local` to generate on your own machine.

**Q: How do I use `fern generate --docs` versus `fern generate`?**
A: `--docs` builds and publishes your documentation site; without it, the command builds and publishes SDKs. They read the same project but different configuration: `docs.yml` for docs, `generators.yml` groups for SDKs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <Microsoft.OxfordComma> reported by reviewdog 🐶
Use the Oxford comma in ', the command builds and publishes SDKs.'.

**Q: How do I use `fern generate --docs` versus `fern generate`?**
A: `--docs` builds and publishes your documentation site; without it, the command builds and publishes SDKs. They read the same project but different configuration: `docs.yml` for docs, `generators.yml` groups for SDKs.

**Q: What does `fern check` do?**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What does `fern check` do?**
A: It validates your API definition and configuration — `fern.config.json`, `generators.yml`, and `docs.yml` — including broken internal links and API examples. It prints nothing when everything passes.

**Q: What's `fern init` and when do I use it?**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

**Q: What does `fern check` do?**
A: It validates your API definition and configuration — `fern.config.json`, `generators.yml`, and `docs.yml` — including broken internal links and API examples. It prints nothing when everything passes.

**Q: What's `fern init` and when do I use it?**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <Microsoft.QuestionMarks> reported by reviewdog 🐶
Use questions sparingly.

**Q: What's `fern init` and when do I use it?**
A: Use it once per project to create the `fern` folder. `fern init --openapi <path or URL>` starts from an existing spec, `fern init --docs` adds a sample docs site, and `--mintlify` or `--readme` import an existing docs site.

**Q: How do I upgrade the Fern CLI?**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <FernStyles.FirstPerson> reported by reviewdog 🐶
Use first person (such as ' I') sparingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants