Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 10 additions & 2 deletions fern/products/dashboard/pages/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Card>
<Card
title="Set up SSO"
icon="regular key-skeleton"
href="/learn/dashboard/configuration/sso"
>
Let your team sign in to Fern through your identity provider.
</Card>
<Card
title="Multi-source settings"
icon="regular code-branch"
Expand Down Expand Up @@ -99,7 +106,7 @@ Monitor and analyze how developers interact with your documentation:
<Card
title="Ask Fern conversations"
icon="regular messages"
href="/learn/ask-fern/getting-started/what-is-ask-fern"
href="/learn/docs/ai-features/ask-fern/overview"
>
Review AI chat conversation history.
<p className="text-(color:--grayscale-a11) font-bold mt-2 flex items-center gap-1">
Expand Down Expand Up @@ -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.
Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
110 changes: 110 additions & 0 deletions fern/products/docs/pages/getting-started/capabilities.mdx
Original file line number Diff line number Diff line change
@@ -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.

<llms-ignore>
<a className="fern-card interactive not-prose rounded-3 relative block border p-6 text-base fe-action-button" href="/learn/docs/getting-started/quickstart">
## Quickstart
<Button intent="primary" rightIcon="arrow-right">
Start building
</Button>
</a>
</llms-ignore>

<llms-only>
[Quickstart](/learn/docs/getting-started/quickstart): Set up a docs site in under 5 minutes.
</llms-only>

<CardGroup cols={2}>
<Card title="How it works" icon="fa-duotone fa-diagram-project" href="/learn/docs/getting-started/how-it-works">
How your Markdown and API specs become a published site
</Card>
<Card title="Project structure" icon="fa-duotone fa-folder-tree" href="/learn/docs/getting-started/project-structure">
The files and folders in a Fern Docs project
</Card>
</CardGroup>

## Capabilities

<CardGroup cols={3}>
<Card title="Component library" icon="fa-duotone fa-cubes" href="/learn/docs/writing-content/components/overview">
Accordions, tabs, callouts, code blocks, and dozens more
</Card>
<Card title="Reusable snippets" icon="fa-duotone fa-recycle" href="/learn/docs/writing-content/reusable-snippets">
Write content once and reuse it across pages
</Card>
<Card title="Fern Editor" icon="fa-duotone fa-pen-to-square" href="/learn/docs/writing-content/fern-editor">
Visual editing for teammates without Git access
</Card>
<Card title="Navigation" icon="fa-duotone fa-sitemap" href="/learn/docs/configuration/navigation-overview">
Sections, tabs, versions, and products in one file
</Card>
<Card title="Changelog pages" icon="fa-duotone fa-clock-rotate-left" href="/learn/docs/configuration/changelogs">
Dated release entries with tag filtering and RSS
</Card>
<Card title="API References" icon="fa-duotone fa-book" href="/learn/docs/api-references/overview">
Generate references from OpenAPI, AsyncAPI, gRPC, and more
</Card>
<Card title="API Explorer" icon="fa-duotone fa-play-circle" href="/learn/docs/api-references/api-explorer">
Send real requests with prefilled auth
</Card>
<Card title="Ask Fern" icon="fa-duotone fa-message-bot" href="/learn/docs/ai-features/ask-fern/overview">
AI search that answers reader questions
</Card>
<Card title="MCP server" icon="fa-duotone fa-plug" href="/learn/docs/ai-features/mcp-server">
Connect Claude Code, Cursor, and other AI clients
</Card>
<Card title="Markdown access" icon="fa-duotone fa-file-code" href="/learn/docs/ai-features/markdown">
Serve every page as Markdown, plus `llms.txt`
</Card>
<Card title="Agent skills" icon="fa-duotone fa-wand-magic-sparkles" href="/learn/docs/ai-features/agent-skills">
Teach coding agents to author your docs
</Card>
<Card title="Fern Writer" icon="fa-duotone fa-pen-nib" href="/learn/docs/ai-features/fern-writer">
A Slack-based writing agent that ships pull requests
</Card>
<Card title="Search" icon="fa-duotone fa-magnifying-glass" href="/learn/docs/customization/search">
Algolia-backed search with custom filtering and ranking
</Card>
<Card title="Custom CSS, JS, and React" icon="fa-duotone fa-paintbrush" href="/learn/docs/customization/custom-css-js">
Style and extend your site with custom code
</Card>
<Card title="Global themes" icon="fa-duotone fa-swatchbook" href="/learn/docs/customization/global-themes">
Define branding once and apply it across child sites
</Card>
<Card title="Authentication" icon="fa-duotone fa-lock" href="/learn/docs/authentication/overview">
Protect your docs with a password, SSO, JWT, or OAuth
</Card>
<Card title="Role-based access control" icon="fa-duotone fa-user-shield" href="/learn/docs/authentication/features/rbac">
Show content based on each reader's role
</Card>
<Card title="Localization" icon="fa-duotone fa-language" href="/learn/docs/localization/overview">
Ship docs in multiple languages from a single source
</Card>
<Card title="Multi-source docs" icon="fa-duotone fa-code-branch" href="/learn/docs/preview-publish/multi-source-docs">
Publish one site from multiple repositories
</Card>
<Card title="Previews" icon="fa-duotone fa-eye" href="/learn/docs/preview-publish/preview-changes">
A local dev server and shareable preview links
</Card>
<Card title="Custom domains" icon="fa-duotone fa-globe" href="/learn/docs/preview-publish/setting-up-your-domain">
Serve your docs from your own subdomain or subpath
</Card>
<Card title="Self-hosting" icon="fa-duotone fa-server" href="/learn/docs/self-hosted/overview">
Deploy on your own infrastructure
</Card>
<Card title="Analytics and integrations" icon="fa-duotone fa-chart-line" href="/learn/docs/integrations/overview">
Forward events to PostHog, Segment, Mixpanel, and more
</Card>
<Card title="SEO and GEO" icon="fa-duotone fa-magnifying-glass-chart" href="/learn/docs/seo/overview">
Control metadata, slugs, redirects, and `robots.txt`
</Card>
<Card title="Accessibility" icon="fa-duotone fa-universal-access" href="/learn/docs/accessibility/overview">
WCAG 2.1 AA contrast, keyboard navigation, and screen readers
</Card>
</CardGroup>
164 changes: 0 additions & 164 deletions fern/products/docs/pages/getting-started/overview.mdx

This file was deleted.

6 changes: 3 additions & 3 deletions fern/products/home/pages/welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ layout: custom
{/* Docs Card */}
<div className="panel-card with-left-border docs-card">
<div className="card-header">
<a className="card-title" href="/docs/getting-started/overview">
<a className="card-title" href="/docs/getting-started/capabilities">
Docs
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="dark:hidden m-0" noZoom />
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="hidden dark:block m-0" noZoom />
Expand All @@ -129,7 +129,7 @@ layout: custom
</a>

<div className="action-buttons-vertical">
<a className="fern-button filled normal primary gap-1 w-fit a-btn" href="/docs/getting-started/overview">
<a className="fern-button filled normal primary gap-1 w-fit a-btn" href="/docs/getting-started/capabilities">
Introduction
<img src="./images/arrow-right-white.svg" alt="Arrow right" className="dark:hidden" noZoom />
<img src="./images/arrow-right-black.svg" alt="Arrow right" className="hidden dark:block" noZoom />
Expand Down Expand Up @@ -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)
Expand Down
Loading