diff --git a/fern/docs.yml b/fern/docs.yml index 0dbe7a493e..69c4d529bd 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -345,6 +345,8 @@ redirects: # ============================================================================ # Docs getting-started (legacy) + - 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/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/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/capabilities.mdx b/fern/products/docs/pages/getting-started/capabilities.mdx new file mode 100644 index 0000000000..fb579d234c --- /dev/null +++ b/fern/products/docs/pages/getting-started/capabilities.mdx @@ -0,0 +1,110 @@ +--- +title: Fern Docs +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. + + + + ## Quickstart + + + + + +[Quickstart](/learn/docs/getting-started/quickstart): Set up a docs site in under 5 minutes. + + + + + How your Markdown and API specs become a published site + + + The files and folders in a Fern Docs project + + + +## Capabilities + + + + 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 + + diff --git a/fern/products/docs/pages/getting-started/overview.mdx b/fern/products/docs/pages/getting-started/overview.mdx deleted file mode 100644 index fa32d48a66..0000000000 --- a/fern/products/docs/pages/getting-started/overview.mdx +++ /dev/null @@ -1,164 +0,0 @@ ---- -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. ---- - - - -

- {/* 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

-

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

- - - -
- Flexible component library - -
-
- Flexible component library - 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.

-
-
-
- - - -
- AI features - -
-
- AI features - Arrow right light - 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.

-
-
-
- - - -
- - - -## 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. - -## Features - -Build your own components, enable Ask Fern, generate API references, and update your docs. - -- [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. - 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 */}
- + Docs Arrow right light Arrow right light @@ -129,7 +129,7 @@ layout: custom
- + Introduction Arrow right Arrow right @@ -394,7 +394,7 @@ Get started with: [TypeScript](/sdks/generators/typescript/quickstart), [Python] A beautiful, interactive documentation website. -- [Introduction](/docs/getting-started/overview) +- [Introduction](/docs/getting-started/capabilities) - [Quickstart](/docs/getting-started/quickstart) - [AI features](/docs/ai-features/overview) - [Fern Editor](/docs/writing-content/fern-editor)