From fb2a8cb8a918a558b225c41040be0861180e19ca Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 6 Aug 2026 15:10:53 +0000 Subject: [PATCH 1/7] Add capabilities pages for Docs, Dashboard, and Fern CLI --- .../cli-api-reference/cli-api-reference.yml | 3 + .../cli-api-reference/pages/capabilities.mdx | 255 ++++++++++++ fern/products/dashboard/dashboard.yml | 3 + .../products/dashboard/pages/capabilities.mdx | 217 +++++++++++ fern/products/docs/docs.yml | 3 + .../pages/getting-started/capabilities.mdx | 367 ++++++++++++++++++ 6 files changed, 848 insertions(+) create mode 100644 fern/products/cli-api-reference/pages/capabilities.mdx create mode 100644 fern/products/dashboard/pages/capabilities.mdx create mode 100644 fern/products/docs/pages/getting-started/capabilities.mdx diff --git a/fern/products/cli-api-reference/cli-api-reference.yml b/fern/products/cli-api-reference/cli-api-reference.yml index 331957b256..202f297fc3 100644 --- a/fern/products/cli-api-reference/cli-api-reference.yml +++ b/fern/products/cli-api-reference/cli-api-reference.yml @@ -4,6 +4,9 @@ navigation: - page: Get started with Fern CLI path: ./pages/cli-get-started.mdx slug: overview + - page: Capabilities + path: ./pages/capabilities.mdx + slug: capabilities - page: Global options path: ./pages/global-options.mdx slug: options diff --git a/fern/products/cli-api-reference/pages/capabilities.mdx b/fern/products/cli-api-reference/pages/capabilities.mdx new file mode 100644 index 0000000000..4cd4eddd57 --- /dev/null +++ b/fern/products/cli-api-reference/pages/capabilities.mdx @@ -0,0 +1,255 @@ +--- +title: Capabilities +subtitle: Everything the Fern CLI can do, in one place. +description: Fern CLI capabilities include project initialization, API definition validation, local previews, publishing docs, generating SDKs, link checking, and version management. +layout: overview +--- + + + + + + Start from an OpenAPI spec, or migrate an existing Mintlify or ReadMe site + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern check` catches API definition and configuration errors before you publish + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern docs md check` validates the Markdown and components in your pages + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern docs dev` serves your site locally with hot reloading + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Generate shareable preview URLs, then list and delete them when you're done + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern generate --docs` builds and publishes your documentation site + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern generate` builds and releases client libraries from your API definition + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern docs diff` compares a preview against production page by page + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern docs link check` finds broken links on a live documentation site + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Export, upload, and list the themes shared across your documentation sites + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern docs md generate` turns Python or C++ source into MDX reference pages + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + `fern export` produces an OpenAPI spec from any supported API definition + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Refresh your spec, merge example overrides, and write OpenAPI customizations + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Log in through GitHub, Google, Postman, or SSO, or set `FERN_TOKEN` in CI + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Upgrade or downgrade the CLI and generators, and enforce an organization-wide version policy + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Resolve and manage the patches Fern Replay keeps across SDK regenerations + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Flags that apply to every command, including `--log-level` and `--api` + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ +
+
+ + +The Fern CLI includes the following capabilities: + +- **Project initialization**: Start from an OpenAPI spec, or migrate an existing Mintlify or ReadMe site. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **Definition validation**: `fern check` catches API definition and configuration errors before you publish. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **MDX validation**: `fern docs md check` validates the Markdown and components in your pages. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) +- **Local preview**: `fern docs dev` serves your site locally with hot reloading. [Learn more](/learn/docs/preview-publish/preview-changes) +- **Preview deployments**: Generate shareable preview URLs, then list and delete them when you're done. [Learn more](/learn/docs/preview-publish/preview-changes) +- **Publishing**: `fern generate --docs` builds and publishes your documentation site. [Learn more](/learn/docs/preview-publish/publishing-your-docs) +- **SDK generation**: `fern generate` builds and releases client libraries from your API definition. [Learn more](/learn/sdks/overview/introduction) +- **Visual diffs**: `fern docs diff` compares a preview against production page by page. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) +- **Link checking**: `fern docs link check` finds broken links on a live documentation site. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) +- **Theme management**: Export, upload, and list the themes shared across your documentation sites. [Learn more](/learn/docs/customization/global-themes) +- **Library documentation**: `fern docs md generate` turns Python or C++ source into MDX reference pages. [Learn more](/learn/docs/api-references/library-reference) +- **OpenAPI export**: `fern export` produces an OpenAPI spec from any supported API definition. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **Spec updates and overrides**: Refresh your spec, merge example overrides, and write OpenAPI customizations. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **Authentication**: Log in through GitHub, Google, Postman, or SSO, or set `FERN_TOKEN` in CI. [Learn more](/learn/dashboard/configuration/api-keys) +- **Version management**: Upgrade or downgrade the CLI and generators, and enforce an organization-wide version policy. [Learn more](/learn/cli-api-reference/cli-reference/version-policy) +- **Custom code preservation**: Resolve and manage the patches Fern Replay keeps across SDK regenerations. [Learn more](/learn/sdks/overview/custom-code) +- **Global options**: Flags that apply to every command, including `--log-level` and `--api`. [Learn more](/learn/cli-api-reference/cli-reference/options) + diff --git a/fern/products/dashboard/dashboard.yml b/fern/products/dashboard/dashboard.yml index 76ca8ca6e6..e1c712a782 100644 --- a/fern/products/dashboard/dashboard.yml +++ b/fern/products/dashboard/dashboard.yml @@ -3,6 +3,9 @@ navigation: contents: - page: Overview path: ./pages/overview.mdx + - page: Capabilities + path: ./pages/capabilities.mdx + slug: capabilities - section: Configuration contents: - page: Member permissions diff --git a/fern/products/dashboard/pages/capabilities.mdx b/fern/products/dashboard/pages/capabilities.mdx new file mode 100644 index 0000000000..811f18f835 --- /dev/null +++ b/fern/products/dashboard/pages/capabilities.mdx @@ -0,0 +1,217 @@ +--- +title: Capabilities +subtitle: Everything you can manage from the Fern Dashboard. +description: Fern Dashboard capabilities include custom domains, member permissions, SSO, API keys, analytics, Ask Fern conversations, feedback, and site management. +layout: overview +--- + + + + + + Point your domain at your docs site with automatic DNS record provisioning + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Assign Admin, Editor, or Viewer roles to control Dashboard and CLI access + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Let your team sign in to Fern with your identity provider + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Create and revoke the keys the CLI uses to authenticate in CI/CD + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Connect a repository so Fern can open pull requests and read your docs + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Restrict access to your docs site with a shared password + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Export your complete documentation site as a PDF + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Track how developers, bots, and LLM crawlers interact with your docs + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + See what readers search for, and what they fail to find + + + + + Review AI chat history to find gaps in your documentation + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Read on-page reactions and edit suggestions from your readers + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Scan your published site for broken internal and external links + + + + + Start and manage visual editing sessions for your team + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Check deployment status, domains, CLI version, and connected repositories + + + + + Purge Ask Fern end-user query logs on a schedule instead of keeping them indefinitely + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Take a site offline temporarily without deleting it + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ +
+
+ + +The Fern Dashboard includes the following capabilities: + +- **Custom domains**: Point your domain at your docs site with automatic DNS record provisioning. [Learn more](/learn/dashboard/configuration/custom-domains) +- **Member permissions**: Assign Admin, Editor, or Viewer roles to control Dashboard and CLI access. [Learn more](/learn/dashboard/configuration/permissions) +- **Single sign-on**: Let your team sign in to Fern with your identity provider. [Learn more](/learn/dashboard/configuration/sso) +- **API keys**: Create and revoke the keys the CLI uses to authenticate in CI/CD. [Learn more](/learn/dashboard/configuration/api-keys) +- **GitHub integration**: Connect a repository so Fern can open pull requests and read your docs. [Learn more](/learn/dashboard/configuration/github-repo) +- **Password protection**: Restrict access to your docs site with a shared password. [Learn more](/learn/dashboard/configuration/password-protection) +- **PDF export**: Export your complete documentation site as a PDF. [Learn more](/learn/dashboard/configuration/pdf-export) +- **Web analytics**: Track how developers, bots, and LLM crawlers interact with your docs. [Learn more](/learn/dashboard/metrics/web-analytics) +- **Search analytics**: See what readers search for, and what they fail to find. +- **Ask Fern conversations**: Review AI chat history to find gaps in your documentation. [Learn more](/learn/docs/ai-features/ask-fern/overview) +- **User feedback**: Read on-page reactions and edit suggestions from your readers. [Learn more](/learn/docs/user-feedback) +- **Broken link scans**: Scan your published site for broken internal and external links. +- **Fern Editor sessions**: Start and manage visual editing sessions for your team. [Learn more](/learn/docs/writing-content/fern-editor) +- **Site information**: Check deployment status, domains, CLI version, and connected repositories. +- **Query log retention**: Purge Ask Fern end-user query logs on a schedule instead of keeping them indefinitely. [Learn more](/learn/docs/ai-features/ask-fern/overview#features) +- **Unpublishing**: Take a site offline temporarily without deleting it. [Learn more](/learn/docs/preview-publish/publishing-your-docs#unpublishing-your-docs) + diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 32fd453d3e..27f3710be1 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -3,6 +3,9 @@ navigation: contents: - page: Overview path: ./pages/getting-started/overview.mdx + - page: Capabilities + path: ./pages/getting-started/capabilities.mdx + slug: capabilities - page: How it works path: ./pages/getting-started/how-it-works.mdx - page: Quickstart diff --git a/fern/products/docs/pages/getting-started/capabilities.mdx b/fern/products/docs/pages/getting-started/capabilities.mdx new file mode 100644 index 0000000000..2f3d6ee8be --- /dev/null +++ b/fern/products/docs/pages/getting-started/capabilities.mdx @@ -0,0 +1,367 @@ +--- +title: Capabilities +subtitle: Everything Fern Docs can do, in one place. +description: Fern Docs capabilities include a component library, generated API references, Ask Fern, MCP, RBAC, localization, self-hosting, analytics, and more. +layout: overview +--- + + + + + + Accordions, tabs, callouts, code blocks, and dozens of other prebuilt components + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Single-source content once and reuse it across pages + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Visual editing for teammates without Markdown or Git access + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Sections, folders, tabs, versions, and products in one config file + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Dated release entries with tag filtering and an RSS feed + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Generate references from OpenAPI, AsyncAPI, gRPC, OpenRPC, and GraphQL + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Send real requests to your API from the docs, with prefilled auth + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + AI search that answers reader questions in your docs and in Slack + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Connect Claude Code, Cursor, and other AI clients to your documentation + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Serve every page as Markdown, plus `llms.txt`, for AI agents and tooling + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Teach coding agents to author your docs, and host skills for your readers + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + A Slack-based technical writing agent that ships updates as pull requests + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Algolia-backed search with configurable filtering and ranking + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Style and extend your site with custom code and components + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Define branding in one repository and apply it across child sites + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Protect your docs with a password, SSO, JWT, or OAuth + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Show pages, sections, and endpoints based on each reader's role + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Ship documentation in multiple languages from a single source + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Publish one site from multiple repositories owned by independent teams + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + A local dev server and shareable preview links for every change + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Serve your docs from your own subdomain or subpath + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Deploy on your own infrastructure to meet security and compliance requirements + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Forward events to PostHog, Google, Segment, Mixpanel, Fullstory, and Intercom + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Control metadata, slugs, redirects, and `robots.txt` + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + WCAG 2.1 AA color contrast, keyboard navigation, and screen reader support + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ +
+
+ + +Fern Docs includes the following capabilities: + +- **Component library**: Accordions, tabs, callouts, code blocks, and dozens of other prebuilt components. [Learn more](/learn/docs/writing-content/components/overview) +- **Reusable snippets**: Single-source content once and reuse it across pages. [Learn more](/learn/docs/writing-content/reusable-snippets) +- **Fern Editor**: Visual editing for teammates without Markdown or Git access. [Learn more](/learn/docs/writing-content/fern-editor) +- **Navigation**: Sections, folders, tabs, versions, and products in one config file. [Learn more](/learn/docs/configuration/navigation-overview) +- **Changelog pages**: Dated release entries with tag filtering and an RSS feed. [Learn more](/learn/docs/configuration/changelogs) +- **API References**: Generate references from OpenAPI, AsyncAPI, gRPC, OpenRPC, and GraphQL. [Learn more](/learn/docs/api-references/overview) +- **API Explorer**: Send real requests to your API from the docs, with prefilled auth. [Learn more](/learn/docs/api-references/api-explorer) +- **Ask Fern**: AI search that answers reader questions in your docs and in Slack. [Learn more](/learn/docs/ai-features/ask-fern/overview) +- **MCP server**: Connect Claude Code, Cursor, and other AI clients to your documentation. [Learn more](/learn/docs/ai-features/mcp-server) +- **Markdown access**: Serve every page as Markdown, plus `llms.txt`, for AI agents and tooling. [Learn more](/learn/docs/ai-features/markdown) +- **Agent skills**: Teach coding agents to author your docs, and host skills for your readers. [Learn more](/learn/docs/ai-features/agent-skills) +- **Fern Writer**: A Slack-based technical writing agent that ships updates as pull requests. [Learn more](/learn/docs/ai-features/fern-writer) +- **Search**: Algolia-backed search with configurable filtering and ranking. [Learn more](/learn/docs/customization/search) +- **Custom CSS, JS, and React**: Style and extend your site with custom code and components. [Learn more](/learn/docs/customization/custom-css-js) +- **Global themes**: Define branding in one repository and apply it across child sites. [Learn more](/learn/docs/customization/global-themes) +- **Authentication**: Protect your docs with a password, SSO, JWT, or OAuth. [Learn more](/learn/docs/authentication/overview) +- **Role-based access control**: Show pages, sections, and endpoints based on each reader's role. [Learn more](/learn/docs/authentication/features/rbac) +- **Localization**: Ship documentation in multiple languages from a single source. [Learn more](/learn/docs/localization/overview) +- **Multi-source docs**: Publish one site from multiple repositories owned by independent teams. [Learn more](/learn/docs/preview-publish/multi-source-docs) +- **Previews**: A local dev server and shareable preview links for every change. [Learn more](/learn/docs/preview-publish/preview-changes) +- **Custom domains**: Serve your docs from your own subdomain or subpath. [Learn more](/learn/docs/preview-publish/setting-up-your-domain) +- **Self-hosting**: Deploy on your own infrastructure to meet security and compliance requirements. [Learn more](/learn/docs/self-hosted/overview) +- **Analytics and integrations**: Forward events to PostHog, Google, Segment, Mixpanel, Fullstory, and Intercom. [Learn more](/learn/docs/integrations/overview) +- **SEO and GEO**: Control metadata, slugs, redirects, and `robots.txt`. [Learn more](/learn/docs/seo/overview) +- **Accessibility**: WCAG 2.1 AA color contrast, keyboard navigation, and screen reader support. [Learn more](/learn/docs/accessibility/overview) + From 4bf3386078b0e31b5288c755727b9ae46ff0ab8b Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 6 Aug 2026 15:12:46 +0000 Subject: [PATCH 2/7] Spell out WCAG on the Docs capabilities page --- fern/products/docs/pages/getting-started/capabilities.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fern/products/docs/pages/getting-started/capabilities.mdx b/fern/products/docs/pages/getting-started/capabilities.mdx index 2f3d6ee8be..bcd71589f9 100644 --- a/fern/products/docs/pages/getting-started/capabilities.mdx +++ b/fern/products/docs/pages/getting-started/capabilities.mdx @@ -321,7 +321,7 @@ layout: overview - WCAG 2.1 AA color contrast, keyboard navigation, and screen reader support + Web Content Accessibility Guidelines (WCAG) 2.1 AA color contrast, keyboard navigation, and screen reader support

Learn more @@ -363,5 +363,5 @@ Fern Docs includes the following capabilities: - **Self-hosting**: Deploy on your own infrastructure to meet security and compliance requirements. [Learn more](/learn/docs/self-hosted/overview) - **Analytics and integrations**: Forward events to PostHog, Google, Segment, Mixpanel, Fullstory, and Intercom. [Learn more](/learn/docs/integrations/overview) - **SEO and GEO**: Control metadata, slugs, redirects, and `robots.txt`. [Learn more](/learn/docs/seo/overview) -- **Accessibility**: WCAG 2.1 AA color contrast, keyboard navigation, and screen reader support. [Learn more](/learn/docs/accessibility/overview) +- **Accessibility**: Web Content Accessibility Guidelines (WCAG) 2.1 AA color contrast, keyboard navigation, and screen reader support. [Learn more](/learn/docs/accessibility/overview) From e1912b2941cf8170b00136ce6d8902f3bbc2580a Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 6 Aug 2026 15:27:32 +0000 Subject: [PATCH 3/7] Shorten CLI cards, drop Dashboard capabilities page, dedupe Docs overview --- .../cli-api-reference/pages/capabilities.mdx | 70 +++--- fern/products/dashboard/dashboard.yml | 3 - .../products/dashboard/pages/capabilities.mdx | 217 ------------------ fern/products/dashboard/pages/overview.mdx | 12 +- .../docs/pages/getting-started/overview.mdx | 74 +----- 5 files changed, 55 insertions(+), 321 deletions(-) delete mode 100644 fern/products/dashboard/pages/capabilities.mdx diff --git a/fern/products/cli-api-reference/pages/capabilities.mdx b/fern/products/cli-api-reference/pages/capabilities.mdx index 4cd4eddd57..00e051f1f1 100644 --- a/fern/products/cli-api-reference/pages/capabilities.mdx +++ b/fern/products/cli-api-reference/pages/capabilities.mdx @@ -9,7 +9,7 @@ layout: overview - Start from an OpenAPI spec, or migrate an existing Mintlify or ReadMe site + Start from an OpenAPI spec, or migrate a Mintlify or ReadMe site

Learn more @@ -22,7 +22,7 @@ layout: overview - `fern check` catches API definition and configuration errors before you publish + Catch API definition and configuration errors before publishing

Learn more @@ -34,8 +34,8 @@ layout: overview - - `fern docs md check` validates the Markdown and components in your pages + + Check the Markdown and components in your pages

Learn more @@ -48,7 +48,7 @@ layout: overview - `fern docs dev` serves your site locally with hot reloading + Serve your docs locally with hot reloading

Learn more @@ -61,7 +61,7 @@ layout: overview - Generate shareable preview URLs, then list and delete them when you're done + Create shareable preview URLs, then list and delete them

Learn more @@ -74,7 +74,7 @@ layout: overview - `fern generate --docs` builds and publishes your documentation site + Build and publish your documentation site

Learn more @@ -87,7 +87,7 @@ layout: overview - `fern generate` builds and releases client libraries from your API definition + Build and release client libraries from your API definition

Learn more @@ -100,7 +100,7 @@ layout: overview - `fern docs diff` compares a preview against production page by page + Compare a preview against production page by page

Learn more @@ -113,7 +113,7 @@ layout: overview - `fern docs link check` finds broken links on a live documentation site + Find broken links on a live documentation site

Learn more @@ -126,7 +126,7 @@ layout: overview - Export, upload, and list the themes shared across your documentation sites + Export, upload, and list the themes shared across your sites

Learn more @@ -139,7 +139,7 @@ layout: overview - `fern docs md generate` turns Python or C++ source into MDX reference pages + Turn Python or C++ source into MDX reference pages

Learn more @@ -152,7 +152,7 @@ layout: overview - `fern export` produces an OpenAPI spec from any supported API definition + Produce an OpenAPI spec from any supported API definition

Learn more @@ -165,7 +165,7 @@ layout: overview - Refresh your spec, merge example overrides, and write OpenAPI customizations + Refresh your spec, merge examples, and write OpenAPI customizations

Learn more @@ -178,7 +178,7 @@ layout: overview - Log in through GitHub, Google, Postman, or SSO, or set `FERN_TOKEN` in CI + Log in with GitHub, Google, Postman, or SSO, or use a token in CI

Learn more @@ -191,7 +191,7 @@ layout: overview - Upgrade or downgrade the CLI and generators, and enforce an organization-wide version policy + Upgrade or downgrade the CLI and generators, and enforce a version policy

Learn more @@ -204,7 +204,7 @@ layout: overview - Resolve and manage the patches Fern Replay keeps across SDK regenerations + Manage the patches Fern Replay keeps across SDK regenerations

Learn more @@ -217,7 +217,7 @@ layout: overview - Flags that apply to every command, including `--log-level` and `--api` + Flags that apply to every command

Learn more @@ -235,21 +235,21 @@ layout: overview The Fern CLI includes the following capabilities: -- **Project initialization**: Start from an OpenAPI spec, or migrate an existing Mintlify or ReadMe site. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **Definition validation**: `fern check` catches API definition and configuration errors before you publish. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **MDX validation**: `fern docs md check` validates the Markdown and components in your pages. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) -- **Local preview**: `fern docs dev` serves your site locally with hot reloading. [Learn more](/learn/docs/preview-publish/preview-changes) -- **Preview deployments**: Generate shareable preview URLs, then list and delete them when you're done. [Learn more](/learn/docs/preview-publish/preview-changes) -- **Publishing**: `fern generate --docs` builds and publishes your documentation site. [Learn more](/learn/docs/preview-publish/publishing-your-docs) -- **SDK generation**: `fern generate` builds and releases client libraries from your API definition. [Learn more](/learn/sdks/overview/introduction) -- **Visual diffs**: `fern docs diff` compares a preview against production page by page. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) -- **Link checking**: `fern docs link check` finds broken links on a live documentation site. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) -- **Theme management**: Export, upload, and list the themes shared across your documentation sites. [Learn more](/learn/docs/customization/global-themes) -- **Library documentation**: `fern docs md generate` turns Python or C++ source into MDX reference pages. [Learn more](/learn/docs/api-references/library-reference) -- **OpenAPI export**: `fern export` produces an OpenAPI spec from any supported API definition. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **Spec updates and overrides**: Refresh your spec, merge example overrides, and write OpenAPI customizations. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **Authentication**: Log in through GitHub, Google, Postman, or SSO, or set `FERN_TOKEN` in CI. [Learn more](/learn/dashboard/configuration/api-keys) -- **Version management**: Upgrade or downgrade the CLI and generators, and enforce an organization-wide version policy. [Learn more](/learn/cli-api-reference/cli-reference/version-policy) -- **Custom code preservation**: Resolve and manage the patches Fern Replay keeps across SDK regenerations. [Learn more](/learn/sdks/overview/custom-code) -- **Global options**: Flags that apply to every command, including `--log-level` and `--api`. [Learn more](/learn/cli-api-reference/cli-reference/options) +- **Project initialization**: Start from an OpenAPI spec, or migrate a Mintlify or ReadMe site. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **Definition validation**: Catch API definition and configuration errors before publishing. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **Markdown validation**: Check the Markdown and components in your pages. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) +- **Local preview**: Serve your docs locally with hot reloading. [Learn more](/learn/docs/preview-publish/preview-changes) +- **Preview deployments**: Create shareable preview URLs, then list and delete them. [Learn more](/learn/docs/preview-publish/preview-changes) +- **Publishing**: Build and publish your documentation site. [Learn more](/learn/docs/preview-publish/publishing-your-docs) +- **SDK generation**: Build and release client libraries from your API definition. [Learn more](/learn/sdks/overview/introduction) +- **Visual diffs**: Compare a preview against production page by page. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) +- **Link checking**: Find broken links on a live documentation site. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) +- **Theme management**: Export, upload, and list the themes shared across your sites. [Learn more](/learn/docs/customization/global-themes) +- **Library documentation**: Turn Python or C++ source into MDX reference pages. [Learn more](/learn/docs/api-references/library-reference) +- **OpenAPI export**: Produce an OpenAPI spec from any supported API definition. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **Spec updates and overrides**: Refresh your spec, merge examples, and write OpenAPI customizations. [Learn more](/learn/cli-api-reference/cli-reference/commands) +- **Authentication**: Log in with GitHub, Google, Postman, or SSO, or use a token in CI. [Learn more](/learn/dashboard/configuration/api-keys) +- **Version management**: Upgrade or downgrade the CLI and generators, and enforce a version policy. [Learn more](/learn/cli-api-reference/cli-reference/version-policy) +- **Custom code preservation**: Manage the patches Fern Replay keeps across SDK regenerations. [Learn more](/learn/sdks/overview/custom-code) +- **Global options**: Flags that apply to every command. [Learn more](/learn/cli-api-reference/cli-reference/options) diff --git a/fern/products/dashboard/dashboard.yml b/fern/products/dashboard/dashboard.yml index e1c712a782..76ca8ca6e6 100644 --- a/fern/products/dashboard/dashboard.yml +++ b/fern/products/dashboard/dashboard.yml @@ -3,9 +3,6 @@ navigation: contents: - page: Overview path: ./pages/overview.mdx - - page: Capabilities - path: ./pages/capabilities.mdx - slug: capabilities - section: Configuration contents: - page: Member permissions diff --git a/fern/products/dashboard/pages/capabilities.mdx b/fern/products/dashboard/pages/capabilities.mdx deleted file mode 100644 index 811f18f835..0000000000 --- a/fern/products/dashboard/pages/capabilities.mdx +++ /dev/null @@ -1,217 +0,0 @@ ---- -title: Capabilities -subtitle: Everything you can manage from the Fern Dashboard. -description: Fern Dashboard capabilities include custom domains, member permissions, SSO, API keys, analytics, Ask Fern conversations, feedback, and site management. -layout: overview ---- - - - - - - Point your domain at your docs site with automatic DNS record provisioning - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Assign Admin, Editor, or Viewer roles to control Dashboard and CLI access - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Let your team sign in to Fern with your identity provider - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Create and revoke the keys the CLI uses to authenticate in CI/CD - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Connect a repository so Fern can open pull requests and read your docs - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Restrict access to your docs site with a shared password - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Export your complete documentation site as a PDF - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Track how developers, bots, and LLM crawlers interact with your docs - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - See what readers search for, and what they fail to find - - - - - Review AI chat history to find gaps in your documentation - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Read on-page reactions and edit suggestions from your readers - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Scan your published site for broken internal and external links - - - - - Start and manage visual editing sessions for your team - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Check deployment status, domains, CLI version, and connected repositories - - - - - Purge Ask Fern end-user query logs on a schedule instead of keeping them indefinitely - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Take a site offline temporarily without deleting it - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - - - -The Fern Dashboard includes the following capabilities: - -- **Custom domains**: Point your domain at your docs site with automatic DNS record provisioning. [Learn more](/learn/dashboard/configuration/custom-domains) -- **Member permissions**: Assign Admin, Editor, or Viewer roles to control Dashboard and CLI access. [Learn more](/learn/dashboard/configuration/permissions) -- **Single sign-on**: Let your team sign in to Fern with your identity provider. [Learn more](/learn/dashboard/configuration/sso) -- **API keys**: Create and revoke the keys the CLI uses to authenticate in CI/CD. [Learn more](/learn/dashboard/configuration/api-keys) -- **GitHub integration**: Connect a repository so Fern can open pull requests and read your docs. [Learn more](/learn/dashboard/configuration/github-repo) -- **Password protection**: Restrict access to your docs site with a shared password. [Learn more](/learn/dashboard/configuration/password-protection) -- **PDF export**: Export your complete documentation site as a PDF. [Learn more](/learn/dashboard/configuration/pdf-export) -- **Web analytics**: Track how developers, bots, and LLM crawlers interact with your docs. [Learn more](/learn/dashboard/metrics/web-analytics) -- **Search analytics**: See what readers search for, and what they fail to find. -- **Ask Fern conversations**: Review AI chat history to find gaps in your documentation. [Learn more](/learn/docs/ai-features/ask-fern/overview) -- **User feedback**: Read on-page reactions and edit suggestions from your readers. [Learn more](/learn/docs/user-feedback) -- **Broken link scans**: Scan your published site for broken internal and external links. -- **Fern Editor sessions**: Start and manage visual editing sessions for your team. [Learn more](/learn/docs/writing-content/fern-editor) -- **Site information**: Check deployment status, domains, CLI version, and connected repositories. -- **Query log retention**: Purge Ask Fern end-user query logs on a schedule instead of keeping them indefinitely. [Learn more](/learn/docs/ai-features/ask-fern/overview#features) -- **Unpublishing**: Take a site offline temporarily without deleting it. [Learn more](/learn/docs/preview-publish/publishing-your-docs#unpublishing-your-docs) - diff --git a/fern/products/dashboard/pages/overview.mdx b/fern/products/dashboard/pages/overview.mdx index 4a2a0c834f..7f2dfd5ce1 100644 --- a/fern/products/dashboard/pages/overview.mdx +++ b/fern/products/dashboard/pages/overview.mdx @@ -48,6 +48,13 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete > Create and manage API keys for CLI authentication in CI/CD. + + Let your team sign in to Fern through your identity provider. + Review AI chat conversation history.

@@ -196,6 +203,7 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete - [Set up custom domain](/learn/dashboard/configuration/custom-domains): Configure your custom domain with automatic DNS record provisioning. - [Member permissions](/learn/dashboard/configuration/permissions): Assign Admin, Editor, or Viewer roles to manage Dashboard and CLI access. - [API keys](/learn/dashboard/configuration/api-keys): Create and manage API keys for CLI authentication in CI/CD. +- [Set up SSO](/learn/dashboard/configuration/sso): Let your team sign in to Fern through your identity provider. - [Integrate GitHub](/learn/dashboard/configuration/github-repo): Connect your GitHub repository to your project. - [Enable Ask Fern](/learn/docs/ai-features/ask-fern/overview): Set up AI-powered chat for your documentation. - [Multi-source settings](/learn/dashboard/configuration/custom-domains#multi-source-settings): Configure default path and search scope for domains shared across multiple repositories. @@ -208,7 +216,7 @@ Monitor and analyze how developers interact with your documentation: - **Search analytics**: Monitor search queries to understand what developers are looking for in your docs. - **Broken links**: Scan your published docs for broken internal and external links. - [Feedback](/learn/docs/user-feedback): View and respond to on-page feedback. -- [Ask Fern conversations](/learn/ask-fern/getting-started/what-is-ask-fern): Review AI chat conversation history. +- [Ask Fern conversations](/learn/docs/ai-features/ask-fern/overview): Review AI chat conversation history. ## Site management diff --git a/fern/products/docs/pages/getting-started/overview.mdx b/fern/products/docs/pages/getting-started/overview.mdx index fa32d48a66..b9592ba5f4 100644 --- a/fern/products/docs/pages/getting-started/overview.mdx +++ b/fern/products/docs/pages/getting-started/overview.mdx @@ -52,55 +52,21 @@ subtitle: Build beautiful, interactive documentation websites with Fern Docs. Cr

Features

-

Build your own components, enable Ask Fern, generate API references, and easily update your docs.

+

Components, generated API references, AI features, authentication, localization, self-hosting, and more.

- +
- Flexible component library - + All capabilities +
- Flexible component library + All capabilities Arrow right light Arrow right light
-

Use pre-built or custom React components for a polished look.

-
-
-
-
- - -
- Fern Editor - -
-
- Fern Editor - Arrow right light - Arrow right light -
-
-

Modify your documentation without touching code and publish to your GitHub.

-
-
-
-
- - -
- API Specs - -
-
- Bring your own API spec - Arrow right light - Arrow right light -
-
-

Use OpenAPI, AsyncAPI, gRPC, OpenRPC, and the Fern spec.

+

Everything Fern Docs can do, on one page.

@@ -117,24 +83,7 @@ subtitle: Build beautiful, interactive documentation websites with Fern Docs. Cr Arrow right light
-

AI-native features including Ask Fern and AI-generated examples.

-
- - -
- - -
- Self-host your docs - -
-
- Self-host your docs - Arrow right light - Arrow right light -
-
-

Deploy on your own infrastructure to meet security or compliance requirements.

+

Ask Fern, MCP, agent-ready Markdown, and AI-generated examples.

@@ -154,11 +103,8 @@ Build a docs site by importing your existing styling and specs. ## Features -Build your own components, enable Ask Fern, generate API references, and update your docs. +Components, generated API references, AI features, authentication, localization, self-hosting, and more. -- [Flexible component library](/docs/writing-content/components/overview): Use pre-built or custom React components for a polished look. -- [Fern Editor](/docs/writing-content/fern-editor): Modify your documentation without touching code and publish to your GitHub. -- [Bring your own API spec](/docs/api-references/generate-api-ref): Use OpenAPI, AsyncAPI, gRPC, OpenRPC, and the Fern spec. -- [AI features](/docs/ai-features/overview): AI-native features including Ask Fern and AI-generated examples. -- [Self-host your docs](/docs/self-hosted/overview): Deploy on your own infrastructure to meet security or compliance requirements. +- [All capabilities](/docs/getting-started/capabilities): Everything Fern Docs can do, on one page. +- [AI features](/docs/ai-features/overview): Ask Fern, MCP, agent-ready Markdown, and AI-generated examples. From 83cba4757190abaade77a23f88026d4d048ce3b7 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 6 Aug 2026 15:57:17 +0000 Subject: [PATCH 4/7] Move the CLI capabilities page to the CLI generator product --- .../cli-api-reference/cli-api-reference.yml | 3 - .../pages => cli-generator}/capabilities.mdx | 128 ++++++++++-------- fern/products/cli-generator/cli-generator.yml | 3 + fern/products/cli-generator/overview.mdx | 4 +- 4 files changed, 78 insertions(+), 60 deletions(-) rename fern/products/{cli-api-reference/pages => cli-generator}/capabilities.mdx (58%) diff --git a/fern/products/cli-api-reference/cli-api-reference.yml b/fern/products/cli-api-reference/cli-api-reference.yml index 202f297fc3..331957b256 100644 --- a/fern/products/cli-api-reference/cli-api-reference.yml +++ b/fern/products/cli-api-reference/cli-api-reference.yml @@ -4,9 +4,6 @@ navigation: - page: Get started with Fern CLI path: ./pages/cli-get-started.mdx slug: overview - - page: Capabilities - path: ./pages/capabilities.mdx - slug: capabilities - page: Global options path: ./pages/global-options.mdx slug: options diff --git a/fern/products/cli-api-reference/pages/capabilities.mdx b/fern/products/cli-generator/capabilities.mdx similarity index 58% rename from fern/products/cli-api-reference/pages/capabilities.mdx rename to fern/products/cli-generator/capabilities.mdx index 00e051f1f1..234d786c28 100644 --- a/fern/products/cli-api-reference/pages/capabilities.mdx +++ b/fern/products/cli-generator/capabilities.mdx @@ -1,15 +1,19 @@ --- title: Capabilities -subtitle: Everything the Fern CLI can do, in one place. -description: Fern CLI capabilities include project initialization, API definition validation, local previews, publishing docs, generating SDKs, link checking, and version management. +subtitle: Everything a Fern-generated CLI ships with. +description: Fern CLI generator capabilities include a single static binary, agent-ready introspection, output formatting, retries, pagination, auth, publishing, and self-hosted generation. +availability: beta layout: overview --- + +The CLI generator is in early access. [Reach out](https://buildwithfern.com/book-demo?type=cli) to get started. + - - Start from an OpenAPI spec, or migrate a Mintlify or ReadMe site + + One statically linked Rust binary, with no language runtime or dependencies

Learn more @@ -21,8 +25,8 @@ layout: overview - - Catch API definition and configuration errors before publishing + + Build a CLI from an OpenAPI spec or a GraphQL introspection schema

Learn more @@ -34,8 +38,8 @@ layout: overview - - Check the Markdown and components in your pages + + Structured JSON help and schema output that AI agents can read

Learn more @@ -47,8 +51,8 @@ layout: overview - - Serve your docs locally with hot reloading + + Return responses as JSON, a table, YAML, or CSV

Learn more @@ -60,8 +64,8 @@ layout: overview - - Create shareable preview URLs, then list and delete them + + Preview the request a command would send without sending it

Learn more @@ -73,8 +77,8 @@ layout: overview - - Build and publish your documentation site + + Exponential backoff on transient failures, honoring `Retry-After`

Learn more @@ -86,8 +90,8 @@ layout: overview - - Build and release client libraries from your API definition + + Walk every page of an annotated endpoint in a single command

Learn more @@ -99,8 +103,8 @@ layout: overview - - Compare a preview against production page by page + + Send files as request bodies and save binary responses to disk

Learn more @@ -112,8 +116,8 @@ layout: overview - - Find broken links on a live documentation site + + Templated server URLs become flags and environment variables

Learn more @@ -125,8 +129,8 @@ layout: overview - - Export, upload, and list the themes shared across your sites + + Credentials from flags, environment variables, or files, including OAuth flows

Learn more @@ -138,8 +142,8 @@ layout: overview - - Turn Python or C++ source into MDX reference pages + + Distinct codes for API, auth, validation, and discovery failures

Learn more @@ -151,8 +155,8 @@ layout: overview - - Produce an OpenAPI spec from any supported API definition + + JSON errors on stderr, with optional daily rotated log files

Learn more @@ -164,8 +168,8 @@ layout: overview - - Refresh your spec, merge examples, and write OpenAPI customizations + + Custom CA bundles, proxies, and timeouts scoped to your binary

Learn more @@ -177,8 +181,8 @@ layout: overview - - Log in with GitHub, Google, Postman, or SSO, or use a token in CI + + Fern extensions control the command tree, naming, filtering, and help text

Learn more @@ -190,8 +194,8 @@ layout: overview - - Upgrade or downgrade the CLI and generators, and enforce a version policy + + Overrides, overlays, multi-spec merging, and hand-written commands

Learn more @@ -203,8 +207,8 @@ layout: overview - - Manage the patches Fern Replay keeps across SDK regenerations + + Cross-platform builds released to npm, Homebrew, and GitHub Releases

Learn more @@ -216,8 +220,21 @@ layout: overview - - Flags that apply to every command + + Run generation on your own infrastructure with Docker + +

+ Learn more + + Arrow right light + + Arrow right light +

+ +
+ + + Each CLI release maps to a specific version of your API

Learn more @@ -233,23 +250,24 @@ layout: overview -The Fern CLI includes the following capabilities: - -- **Project initialization**: Start from an OpenAPI spec, or migrate a Mintlify or ReadMe site. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **Definition validation**: Catch API definition and configuration errors before publishing. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **Markdown validation**: Check the Markdown and components in your pages. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) -- **Local preview**: Serve your docs locally with hot reloading. [Learn more](/learn/docs/preview-publish/preview-changes) -- **Preview deployments**: Create shareable preview URLs, then list and delete them. [Learn more](/learn/docs/preview-publish/preview-changes) -- **Publishing**: Build and publish your documentation site. [Learn more](/learn/docs/preview-publish/publishing-your-docs) -- **SDK generation**: Build and release client libraries from your API definition. [Learn more](/learn/sdks/overview/introduction) -- **Visual diffs**: Compare a preview against production page by page. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) -- **Link checking**: Find broken links on a live documentation site. [Learn more](/learn/cli-api-reference/cli-reference/commands#documentation-commands) -- **Theme management**: Export, upload, and list the themes shared across your sites. [Learn more](/learn/docs/customization/global-themes) -- **Library documentation**: Turn Python or C++ source into MDX reference pages. [Learn more](/learn/docs/api-references/library-reference) -- **OpenAPI export**: Produce an OpenAPI spec from any supported API definition. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **Spec updates and overrides**: Refresh your spec, merge examples, and write OpenAPI customizations. [Learn more](/learn/cli-api-reference/cli-reference/commands) -- **Authentication**: Log in with GitHub, Google, Postman, or SSO, or use a token in CI. [Learn more](/learn/dashboard/configuration/api-keys) -- **Version management**: Upgrade or downgrade the CLI and generators, and enforce a version policy. [Learn more](/learn/cli-api-reference/cli-reference/version-policy) -- **Custom code preservation**: Manage the patches Fern Replay keeps across SDK regenerations. [Learn more](/learn/sdks/overview/custom-code) -- **Global options**: Flags that apply to every command. [Learn more](/learn/cli-api-reference/cli-reference/options) +Fern-generated CLIs include the following capabilities: + +- **Single static binary**: One statically linked Rust binary, with no language runtime or dependencies. [Learn more](/learn/cli-generator/get-started/overview) +- **Generated from your spec**: Build a CLI from an OpenAPI spec or a GraphQL introspection schema. [Learn more](/learn/cli-generator/get-started/quickstart) +- **Runtime introspection**: Structured JSON help and schema output that AI agents can read. [Learn more](/learn/cli-generator/get-started/features#passing-parameters) +- **Output formatting**: Return responses as JSON, a table, YAML, or CSV. [Learn more](/learn/cli-generator/get-started/features#output-formatting) +- **Dry-run mode**: Preview the request a command would send without sending it. [Learn more](/learn/cli-generator/get-started/features#dry-run-mode) +- **Retries with backoff**: Exponential backoff on transient failures, honoring `Retry-After`. [Learn more](/learn/cli-generator/get-started/features#retries-with-backoff) +- **Pagination**: Walk every page of an annotated endpoint in a single command. [Learn more](/learn/cli-generator/get-started/features#pagination) +- **File uploads and downloads**: Send files as request bodies and save binary responses to disk. [Learn more](/learn/cli-generator/get-started/features#file-uploads-and-downloads) +- **Server URL variables**: Templated server URLs become flags and environment variables. [Learn more](/learn/cli-generator/get-started/features#server-url-variables) +- **Authentication**: Credentials from flags, environment variables, or files, including OAuth flows. [Learn more](/learn/cli-generator/get-started/authentication) +- **Exit codes**: Distinct codes for API, auth, validation, and discovery failures. [Learn more](/learn/cli-generator/get-started/features#exit-codes) +- **Structured logging**: JSON errors on stderr, with optional daily rotated log files. [Learn more](/learn/cli-generator/get-started/features#structured-logging) +- **TLS and proxy configuration**: Custom CA bundles, proxies, and timeouts scoped to your binary. [Learn more](/learn/cli-generator/get-started/features#tls-proxies-and-ca-bundles) +- **Command shaping**: Fern extensions control the command tree, naming, filtering, and help text. [Learn more](/learn/cli-generator/get-started/openapi-extensions) +- **Customization**: Overrides, overlays, multi-spec merging, and hand-written commands. [Learn more](/learn/cli-generator/get-started/customization) +- **Publishing**: Cross-platform builds released to npm, Homebrew, and GitHub Releases. [Learn more](/learn/cli-generator/get-started/publishing) +- **Self-hosted generation**: Run generation on your own infrastructure with Docker. [Learn more](/learn/cli-generator/get-started/local-generation) +- **Version pinning**: Each CLI release maps to a specific version of your API. [Learn more](/learn/cli-generator/get-started/configuration) diff --git a/fern/products/cli-generator/cli-generator.yml b/fern/products/cli-generator/cli-generator.yml index 3a1826a43e..98212724ee 100644 --- a/fern/products/cli-generator/cli-generator.yml +++ b/fern/products/cli-generator/cli-generator.yml @@ -7,6 +7,9 @@ navigation: - page: Quickstart path: ./quickstart.mdx slug: quickstart + - page: Capabilities + path: ./capabilities.mdx + slug: capabilities - page: Features path: ./features.mdx slug: features diff --git a/fern/products/cli-generator/overview.mdx b/fern/products/cli-generator/overview.mdx index f86ab88904..a7f54a6498 100644 --- a/fern/products/cli-generator/overview.mdx +++ b/fern/products/cli-generator/overview.mdx @@ -59,8 +59,8 @@ The output is a single statically linked Rust binary. Users drop it onto their P Generate a working CLI binary from an OpenAPI spec in five steps. - - Output formatting, retries, pagination, dry-run, TLS configuration. + + Everything a generated CLI ships with, on one page. Generator-specific and shared options in generators.yml. From 26ef819639e62b7db40dc6dab31ed0c5f9bb3d2d Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 6 Aug 2026 13:03:46 -0400 Subject: [PATCH 5/7] add capabilities --- fern/docs.yml | 2 + fern/products/docs/docs.yml | 3 - .../pages/getting-started/capabilities.mdx | 367 ------------------ .../docs/pages/getting-started/overview.mdx | 196 +++++----- 4 files changed, 100 insertions(+), 468 deletions(-) delete mode 100644 fern/products/docs/pages/getting-started/capabilities.mdx diff --git a/fern/docs.yml b/fern/docs.yml index 0dbe7a493e..f1b4a6cef2 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -345,6 +345,8 @@ redirects: # ============================================================================ # Docs getting-started (legacy) + - source: /learn/docs/getting-started/capabilities + destination: /learn/docs/getting-started/overview#capabilities - source: /learn/docs/getting-started/customer-showcase destination: https://buildwithfern.com/customers - source: /learn/docs/getting-started/global-configuration diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 27f3710be1..32fd453d3e 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -3,9 +3,6 @@ navigation: contents: - page: Overview path: ./pages/getting-started/overview.mdx - - page: Capabilities - path: ./pages/getting-started/capabilities.mdx - slug: capabilities - page: How it works path: ./pages/getting-started/how-it-works.mdx - page: Quickstart diff --git a/fern/products/docs/pages/getting-started/capabilities.mdx b/fern/products/docs/pages/getting-started/capabilities.mdx deleted file mode 100644 index bcd71589f9..0000000000 --- a/fern/products/docs/pages/getting-started/capabilities.mdx +++ /dev/null @@ -1,367 +0,0 @@ ---- -title: Capabilities -subtitle: Everything Fern Docs can do, in one place. -description: Fern Docs capabilities include a component library, generated API references, Ask Fern, MCP, RBAC, localization, self-hosting, analytics, and more. -layout: overview ---- - - - - - - Accordions, tabs, callouts, code blocks, and dozens of other prebuilt components - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Single-source content once and reuse it across pages - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Visual editing for teammates without Markdown or Git access - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Sections, folders, tabs, versions, and products in one config file - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Dated release entries with tag filtering and an RSS feed - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Generate references from OpenAPI, AsyncAPI, gRPC, OpenRPC, and GraphQL - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Send real requests to your API from the docs, with prefilled auth - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - AI search that answers reader questions in your docs and in Slack - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Connect Claude Code, Cursor, and other AI clients to your documentation - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Serve every page as Markdown, plus `llms.txt`, for AI agents and tooling - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Teach coding agents to author your docs, and host skills for your readers - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - A Slack-based technical writing agent that ships updates as pull requests - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Algolia-backed search with configurable filtering and ranking - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Style and extend your site with custom code and components - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Define branding in one repository and apply it across child sites - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Protect your docs with a password, SSO, JWT, or OAuth - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Show pages, sections, and endpoints based on each reader's role - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Ship documentation in multiple languages from a single source - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Publish one site from multiple repositories owned by independent teams - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - A local dev server and shareable preview links for every change - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Serve your docs from your own subdomain or subpath - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Deploy on your own infrastructure to meet security and compliance requirements - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Forward events to PostHog, Google, Segment, Mixpanel, Fullstory, and Intercom - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Control metadata, slugs, redirects, and `robots.txt` - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Web Content Accessibility Guidelines (WCAG) 2.1 AA color contrast, keyboard navigation, and screen reader support - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- -
-
- - -Fern Docs includes the following capabilities: - -- **Component library**: Accordions, tabs, callouts, code blocks, and dozens of other prebuilt components. [Learn more](/learn/docs/writing-content/components/overview) -- **Reusable snippets**: Single-source content once and reuse it across pages. [Learn more](/learn/docs/writing-content/reusable-snippets) -- **Fern Editor**: Visual editing for teammates without Markdown or Git access. [Learn more](/learn/docs/writing-content/fern-editor) -- **Navigation**: Sections, folders, tabs, versions, and products in one config file. [Learn more](/learn/docs/configuration/navigation-overview) -- **Changelog pages**: Dated release entries with tag filtering and an RSS feed. [Learn more](/learn/docs/configuration/changelogs) -- **API References**: Generate references from OpenAPI, AsyncAPI, gRPC, OpenRPC, and GraphQL. [Learn more](/learn/docs/api-references/overview) -- **API Explorer**: Send real requests to your API from the docs, with prefilled auth. [Learn more](/learn/docs/api-references/api-explorer) -- **Ask Fern**: AI search that answers reader questions in your docs and in Slack. [Learn more](/learn/docs/ai-features/ask-fern/overview) -- **MCP server**: Connect Claude Code, Cursor, and other AI clients to your documentation. [Learn more](/learn/docs/ai-features/mcp-server) -- **Markdown access**: Serve every page as Markdown, plus `llms.txt`, for AI agents and tooling. [Learn more](/learn/docs/ai-features/markdown) -- **Agent skills**: Teach coding agents to author your docs, and host skills for your readers. [Learn more](/learn/docs/ai-features/agent-skills) -- **Fern Writer**: A Slack-based technical writing agent that ships updates as pull requests. [Learn more](/learn/docs/ai-features/fern-writer) -- **Search**: Algolia-backed search with configurable filtering and ranking. [Learn more](/learn/docs/customization/search) -- **Custom CSS, JS, and React**: Style and extend your site with custom code and components. [Learn more](/learn/docs/customization/custom-css-js) -- **Global themes**: Define branding in one repository and apply it across child sites. [Learn more](/learn/docs/customization/global-themes) -- **Authentication**: Protect your docs with a password, SSO, JWT, or OAuth. [Learn more](/learn/docs/authentication/overview) -- **Role-based access control**: Show pages, sections, and endpoints based on each reader's role. [Learn more](/learn/docs/authentication/features/rbac) -- **Localization**: Ship documentation in multiple languages from a single source. [Learn more](/learn/docs/localization/overview) -- **Multi-source docs**: Publish one site from multiple repositories owned by independent teams. [Learn more](/learn/docs/preview-publish/multi-source-docs) -- **Previews**: A local dev server and shareable preview links for every change. [Learn more](/learn/docs/preview-publish/preview-changes) -- **Custom domains**: Serve your docs from your own subdomain or subpath. [Learn more](/learn/docs/preview-publish/setting-up-your-domain) -- **Self-hosting**: Deploy on your own infrastructure to meet security and compliance requirements. [Learn more](/learn/docs/self-hosted/overview) -- **Analytics and integrations**: Forward events to PostHog, Google, Segment, Mixpanel, Fullstory, and Intercom. [Learn more](/learn/docs/integrations/overview) -- **SEO and GEO**: Control metadata, slugs, redirects, and `robots.txt`. [Learn more](/learn/docs/seo/overview) -- **Accessibility**: Web Content Accessibility Guidelines (WCAG) 2.1 AA color contrast, keyboard navigation, and screen reader support. [Learn more](/learn/docs/accessibility/overview) - diff --git a/fern/products/docs/pages/getting-started/overview.mdx b/fern/products/docs/pages/getting-started/overview.mdx index b9592ba5f4..fb579d234c 100644 --- a/fern/products/docs/pages/getting-started/overview.mdx +++ b/fern/products/docs/pages/getting-started/overview.mdx @@ -1,110 +1,110 @@ --- title: Fern Docs -subtitle: Build beautiful, interactive documentation websites with Fern Docs. Create API references, custom components, and AI-powered features in under 5 minutes. +subtitle: Build beautiful, interactive documentation websites with Fern Docs. +description: Create API references, custom components, and AI-powered features in under 5 minutes. Fern Docs includes a component library, generated API references, Ask Fern, MCP, RBAC, localization, self-hosting, analytics, and more. +layout: overview --- +Build a docs site quickly by importing your existing styling and specs. -
- {/* Dashed Pattern - Left Side */} -
- - {/* Dashed Pattern - Right Side */} -
- -

Get started

-

Build a docs site quickly by importing your existing styling and specs.

- - -
-
- Quickstart - -
-
- Quickstart - Arrow right light - Arrow right light -
-
-

Set up a documentation site in under 5 minutes.

-
-
-
-
- - -
- Configure with ease - -
-
- Configure with ease - Arrow right light - Arrow right light -
-
-

Use one simple file to generate documentation that fits your brand.

-
-
-
-
- - -

Features

-

Components, generated API references, AI features, authentication, localization, self-hosting, and more.

- - - -
- All capabilities - -
-
- All capabilities - Arrow right light - Arrow right light -
-
-

Everything Fern Docs can do, on one page.

-
-
-
-
- - -
- AI features - -
-
- AI features - Arrow right light - Arrow right light -
-
-

Ask Fern, MCP, agent-ready Markdown, and AI-generated examples.

-
-
-
-
- -
-
+ + ## Quickstart + + -## Get started - -Build a docs site by importing your existing styling and specs. - -- [Quickstart](/docs/getting-started/quickstart): Set up a documentation site in under 5 minutes. -- [Configure with ease](/docs/configuration/site-level-settings): Use one simple file to generate documentation that fits your brand. +[Quickstart](/learn/docs/getting-started/quickstart): Set up a docs site in under 5 minutes. + -## Features + + + How your Markdown and API specs become a published site + + + The files and folders in a Fern Docs project + + -Components, generated API references, AI features, authentication, localization, self-hosting, and more. +## Capabilities -- [All capabilities](/docs/getting-started/capabilities): Everything Fern Docs can do, on one page. -- [AI features](/docs/ai-features/overview): Ask Fern, MCP, agent-ready Markdown, and AI-generated examples. - + + + Accordions, tabs, callouts, code blocks, and dozens more + + + Write content once and reuse it across pages + + + Visual editing for teammates without Git access + + + Sections, tabs, versions, and products in one file + + + Dated release entries with tag filtering and RSS + + + Generate references from OpenAPI, AsyncAPI, gRPC, and more + + + Send real requests with prefilled auth + + + AI search that answers reader questions + + + Connect Claude Code, Cursor, and other AI clients + + + Serve every page as Markdown, plus `llms.txt` + + + Teach coding agents to author your docs + + + A Slack-based writing agent that ships pull requests + + + Algolia-backed search with custom filtering and ranking + + + Style and extend your site with custom code + + + Define branding once and apply it across child sites + + + Protect your docs with a password, SSO, JWT, or OAuth + + + Show content based on each reader's role + + + Ship docs in multiple languages from a single source + + + Publish one site from multiple repositories + + + A local dev server and shareable preview links + + + Serve your docs from your own subdomain or subpath + + + Deploy on your own infrastructure + + + Forward events to PostHog, Segment, Mixpanel, and more + + + Control metadata, slugs, redirects, and `robots.txt` + + + WCAG 2.1 AA contrast, keyboard navigation, and screen readers + + From d56f43fc08171fb87e82d6ac73680f1b979978e9 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 6 Aug 2026 17:06:26 +0000 Subject: [PATCH 6/7] Remove the CLI generator capabilities page --- fern/products/cli-generator/capabilities.mdx | 273 ------------------ fern/products/cli-generator/cli-generator.yml | 3 - fern/products/cli-generator/overview.mdx | 4 +- 3 files changed, 2 insertions(+), 278 deletions(-) delete mode 100644 fern/products/cli-generator/capabilities.mdx diff --git a/fern/products/cli-generator/capabilities.mdx b/fern/products/cli-generator/capabilities.mdx deleted file mode 100644 index 234d786c28..0000000000 --- a/fern/products/cli-generator/capabilities.mdx +++ /dev/null @@ -1,273 +0,0 @@ ---- -title: Capabilities -subtitle: Everything a Fern-generated CLI ships with. -description: Fern CLI generator capabilities include a single static binary, agent-ready introspection, output formatting, retries, pagination, auth, publishing, and self-hosted generation. -availability: beta -layout: overview ---- - - -The CLI generator is in early access. [Reach out](https://buildwithfern.com/book-demo?type=cli) to get started. - - - - - - One statically linked Rust binary, with no language runtime or dependencies - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Build a CLI from an OpenAPI spec or a GraphQL introspection schema - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Structured JSON help and schema output that AI agents can read - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Return responses as JSON, a table, YAML, or CSV - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Preview the request a command would send without sending it - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Exponential backoff on transient failures, honoring `Retry-After` - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Walk every page of an annotated endpoint in a single command - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Send files as request bodies and save binary responses to disk - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Templated server URLs become flags and environment variables - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Credentials from flags, environment variables, or files, including OAuth flows - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Distinct codes for API, auth, validation, and discovery failures - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - JSON errors on stderr, with optional daily rotated log files - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Custom CA bundles, proxies, and timeouts scoped to your binary - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Fern extensions control the command tree, naming, filtering, and help text - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Overrides, overlays, multi-spec merging, and hand-written commands - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Cross-platform builds released to npm, Homebrew, and GitHub Releases - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Run generation on your own infrastructure with Docker - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- - - Each CLI release maps to a specific version of your API - -

- Learn more - - Arrow right light - - Arrow right light -

- -
- -
-
- - -Fern-generated CLIs include the following capabilities: - -- **Single static binary**: One statically linked Rust binary, with no language runtime or dependencies. [Learn more](/learn/cli-generator/get-started/overview) -- **Generated from your spec**: Build a CLI from an OpenAPI spec or a GraphQL introspection schema. [Learn more](/learn/cli-generator/get-started/quickstart) -- **Runtime introspection**: Structured JSON help and schema output that AI agents can read. [Learn more](/learn/cli-generator/get-started/features#passing-parameters) -- **Output formatting**: Return responses as JSON, a table, YAML, or CSV. [Learn more](/learn/cli-generator/get-started/features#output-formatting) -- **Dry-run mode**: Preview the request a command would send without sending it. [Learn more](/learn/cli-generator/get-started/features#dry-run-mode) -- **Retries with backoff**: Exponential backoff on transient failures, honoring `Retry-After`. [Learn more](/learn/cli-generator/get-started/features#retries-with-backoff) -- **Pagination**: Walk every page of an annotated endpoint in a single command. [Learn more](/learn/cli-generator/get-started/features#pagination) -- **File uploads and downloads**: Send files as request bodies and save binary responses to disk. [Learn more](/learn/cli-generator/get-started/features#file-uploads-and-downloads) -- **Server URL variables**: Templated server URLs become flags and environment variables. [Learn more](/learn/cli-generator/get-started/features#server-url-variables) -- **Authentication**: Credentials from flags, environment variables, or files, including OAuth flows. [Learn more](/learn/cli-generator/get-started/authentication) -- **Exit codes**: Distinct codes for API, auth, validation, and discovery failures. [Learn more](/learn/cli-generator/get-started/features#exit-codes) -- **Structured logging**: JSON errors on stderr, with optional daily rotated log files. [Learn more](/learn/cli-generator/get-started/features#structured-logging) -- **TLS and proxy configuration**: Custom CA bundles, proxies, and timeouts scoped to your binary. [Learn more](/learn/cli-generator/get-started/features#tls-proxies-and-ca-bundles) -- **Command shaping**: Fern extensions control the command tree, naming, filtering, and help text. [Learn more](/learn/cli-generator/get-started/openapi-extensions) -- **Customization**: Overrides, overlays, multi-spec merging, and hand-written commands. [Learn more](/learn/cli-generator/get-started/customization) -- **Publishing**: Cross-platform builds released to npm, Homebrew, and GitHub Releases. [Learn more](/learn/cli-generator/get-started/publishing) -- **Self-hosted generation**: Run generation on your own infrastructure with Docker. [Learn more](/learn/cli-generator/get-started/local-generation) -- **Version pinning**: Each CLI release maps to a specific version of your API. [Learn more](/learn/cli-generator/get-started/configuration) - diff --git a/fern/products/cli-generator/cli-generator.yml b/fern/products/cli-generator/cli-generator.yml index 98212724ee..3a1826a43e 100644 --- a/fern/products/cli-generator/cli-generator.yml +++ b/fern/products/cli-generator/cli-generator.yml @@ -7,9 +7,6 @@ navigation: - page: Quickstart path: ./quickstart.mdx slug: quickstart - - page: Capabilities - path: ./capabilities.mdx - slug: capabilities - page: Features path: ./features.mdx slug: features diff --git a/fern/products/cli-generator/overview.mdx b/fern/products/cli-generator/overview.mdx index a7f54a6498..f86ab88904 100644 --- a/fern/products/cli-generator/overview.mdx +++ b/fern/products/cli-generator/overview.mdx @@ -59,8 +59,8 @@ The output is a single statically linked Rust binary. Users drop it onto their P Generate a working CLI binary from an OpenAPI spec in five steps. - - Everything a generated CLI ships with, on one page. + + Output formatting, retries, pagination, dry-run, TLS configuration. Generator-specific and shared options in generators.yml. From 5f471dbf045c0b406524b445fd5baeebed1e61df Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 6 Aug 2026 13:57:30 -0400 Subject: [PATCH 7/7] update name --- fern/docs.yml | 4 ++-- fern/products/docs/docs.yml | 4 ++-- .../getting-started/{overview.mdx => capabilities.mdx} | 0 fern/products/home/pages/welcome.mdx | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-) rename fern/products/docs/pages/getting-started/{overview.mdx => capabilities.mdx} (100%) diff --git a/fern/docs.yml b/fern/docs.yml index f1b4a6cef2..69c4d529bd 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -345,8 +345,8 @@ redirects: # ============================================================================ # Docs getting-started (legacy) - - source: /learn/docs/getting-started/capabilities - destination: /learn/docs/getting-started/overview#capabilities + - source: /learn/docs/getting-started/overview + destination: /learn/docs/getting-started/capabilities - source: /learn/docs/getting-started/customer-showcase destination: https://buildwithfern.com/customers - source: /learn/docs/getting-started/global-configuration diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 32fd453d3e..e6214d4f25 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -1,8 +1,8 @@ navigation: - section: Getting started contents: - - page: Overview - path: ./pages/getting-started/overview.mdx + - page: Capabilities + path: ./pages/getting-started/capabilities.mdx - page: How it works path: ./pages/getting-started/how-it-works.mdx - page: Quickstart diff --git a/fern/products/docs/pages/getting-started/overview.mdx b/fern/products/docs/pages/getting-started/capabilities.mdx similarity index 100% rename from fern/products/docs/pages/getting-started/overview.mdx rename to fern/products/docs/pages/getting-started/capabilities.mdx diff --git a/fern/products/home/pages/welcome.mdx b/fern/products/home/pages/welcome.mdx index 0de8f47702..d2df33fa04 100644 --- a/fern/products/home/pages/welcome.mdx +++ b/fern/products/home/pages/welcome.mdx @@ -111,7 +111,7 @@ layout: custom {/* Docs Card */}