Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 3 additions & 1 deletion fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,9 @@ redirects:
- source: /learn/user-feedback
destination: /learn/docs/user-feedback
- source: /learn/docs/customization/what-is-docs-yml
destination: /learn/docs/configuration/what-is-docs-yml
destination: /learn/docs/configuration/site-level-settings
- source: /learn/docs/configuration/what-is-docs-yml
destination: /learn/docs/configuration/site-level-settings

# ============================================================================
# CLI & API REFERENCE REDIRECTS
Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/ferndef-pages/availability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Availability in Fern Definition
description: Add availability to Fern Definition API services, endpoints, types, or properties to indicate their release status.
---

You can add `availability` to an endpoint, type, or property within your Fern Definition. You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/what-is-docs-yml).
You can add `availability` to an endpoint, type, or property within your Fern Definition. You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/site-level-settings).
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.


## Endpoints, types, and properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Mark endpoint availability status using `x-fern-availability` exten

The `x-fern-availability` extension is used to mark the availability of an endpoint within your OpenAPI definition. The availability information propagates into the generated Fern Docs website as visual tags.

You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/what-is-docs-yml).
You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/site-level-settings).
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.


## Endpoint

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Ask Fern is a **Retrieval Augmented Generation (RAG)** system that appears as a
Ask Fern appears as a resizable side panel on your documentation site. Users can drag to resize it or use the expand/minimize button to control their viewing experience.

Key behaviors:
- **Adaptive layout** – Seamlessly integrates with all [Fern Docs layouts](/docs/configuration/what-is-docs-yml#layout-configuration)
- **Adaptive layout** – Seamlessly integrates with all [Fern Docs layouts](/docs/configuration/site-level-settings#layout-configuration)
- **Persistent navigation** – Side panel stays open as users browse different pages or click links provided by the AI responses
- **Document-specific queries** – Users can ask questions about the current page through a dropdown option
- **Mobile optimization** – Expands to full screen when users start typing on mobile devices
Expand Down
4 changes: 2 additions & 2 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ navigation:
icon: fa-regular fa-clock-rotate-left
- section: Configuration
contents:
- page: What is docs.yml?
path: ./pages/customization/what-is-docs-yml.mdx
- page: Site-level settings
path: ./pages/customization/site-level-settings.mdx
- page: Navigation
path: ./pages/navigation/overview.mdx
- page: Tabs and tab variants
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/accessibility/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Fern automatically enforces [WCAG 2.1 AA](https://www.w3.org/WAI/WCAG21/quickref
- **UI elements**: 3:1 minimum
- **Enhanced**: 7:1 when feasible ([WCAG AAA](https://www.w3.org/WAI/WCAG21/quickref/#contrast-enhanced))

When you [configure colors in your `docs.yml` file](/learn/docs/configuration/what-is-docs-yml#colors-configuration), Fern validates accent colors. If your accent color doesn't meet the minimum contrast ratio against your background color, Fern will:
When you [configure colors in your `docs.yml` file](/learn/docs/configuration/site-level-settings#colors-configuration), Fern validates accent colors. If your accent color doesn't meet the minimum contrast ratio against your background color, Fern will:

1. Display a warning during `fern check` validation
2. Automatically adjust the accent color at runtime to meet WCAG AA standards
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/api-references/sdk-snippets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Enable SDK code examples in TypeScript, Python, Go, and more from t
<Note title="Dynamic snippets">
By default, SDK snippets are static code examples. Alternatively, you can use dynamic SDK snippets that allow users to modify parameters and see code examples update in real time.

To use dynamic snippets, [enable them in your `docs.yml`](/docs/configuration/what-is-docs-yml#dynamic-snippets-configuration) and then complete the setup instructions on this page.
To use dynamic snippets, [enable them in your `docs.yml`](/docs/configuration/site-level-settings#dynamic-snippets-configuration) and then complete the setup instructions on this page.
</Note>

<Frame>
Expand Down
4 changes: 2 additions & 2 deletions fern/products/docs/pages/changelog/2025-11-02.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ navbar-links:
href: https://example.com/guides
```

Learn more in the [navbar links configuration documentation](/learn/docs/configuration/what-is-docs-yml#navbar-links-configuration).
Learn more in the [navbar links configuration documentation](/learn/docs/configuration/site-level-settings#navbar-links-configuration).

## API Explorer direct requests

Expand All @@ -30,4 +30,4 @@ settings:
Your API must have CORS enabled to allow requests from the documentation domain.
</Warning>

Learn more in the [docs.yml reference documentation](/learn/docs/configuration/what-is-docs-yml#settingsdisable-explorer-proxy).
Learn more in the [docs.yml reference documentation](/learn/docs/configuration/site-level-settings#settingsdisable-explorer-proxy).
2 changes: 1 addition & 1 deletion fern/products/docs/pages/changelog/2025-11-03.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ navigation:

## Custom icons across your navigation

You can now use your own image files as icons throughout your `docs.yml` navigation config, including for [navbar link](/learn/docs/configuration/what-is-docs-yml#navbar-links-configuration), [section, page](/learn/docs/configuration/navigation#sidebar-icons), and [product](/learn/docs/configuration/products#add-your-product-configuration) icons.
You can now use your own image files as icons throughout your `docs.yml` navigation config, including for [navbar link](/learn/docs/configuration/site-level-settings#navbar-links-configuration), [section, page](/learn/docs/configuration/navigation#sidebar-icons), and [product](/learn/docs/configuration/products#add-your-product-configuration) icons.
Copy link
Contributor

Choose a reason for hiding this comment

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

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


Icons now support three formats:
- **Font Awesome icons**: Use icon names like `fa-solid fa-seedling` or `fa-regular fa-leaf`. Pro and Brand icons from Font Awesome are supported.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ subtitle: Add custom CSS, global JavaScript, and UI components.
description: Add brand-specific styling, user interactions. and components to make your docs your own.
---

This page covers how to customize your docs with CSS, JavaScript, and custom components. However, you can [customize many things directly in your `docs.yml` file](/docs/configuration/what-is-docs-yml), including colors, typography, navbar links, layout, analytics, and metadata. Try these built-in options first before adding custom code.
This page covers how to customize your docs with CSS, JavaScript, and custom components. However, you can [customize many things directly in your `docs.yml` file](/docs/configuration/site-level-settings), including colors, typography, navbar links, layout, analytics, and metadata. Try these built-in options first before adding custom code.

## Custom CSS

Expand Down Expand Up @@ -53,7 +53,7 @@ css:

<Note>
For customizing the background, logo, font, and layout of your Docs via Fern's built-in styling,
check out the [Global Configuration](/learn/docs/configuration/what-is-docs-yml).
check out the [Global Configuration](/learn/docs/configuration/site-level-settings).
</Note>

### Common use cases
Expand Down
6 changes: 3 additions & 3 deletions fern/products/docs/pages/customization/frontmatter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ max-toc-depth: 3
<ParamField path="hide-nav-links" type="boolean" required={false} default={false}>
Controls the conditional rendering of the navigation links (previous, next) at the bottom of the page. Set to true to disable this feature.

This can be set globally in the [global configuration](/learn/docs/configuration/what-is-docs-yml#layout-configuration).
This can be set globally in the [global configuration](/learn/docs/configuration/site-level-settings#layout-configuration).
</ParamField>

<CodeBlock title="Example hide-nav-links">
Expand All @@ -197,7 +197,7 @@ hide-nav-links: true
<ParamField path="hide-feedback" type="boolean" required={false} default={false}>
Controls the conditional rendering of the on-page feedback form at the bottom of the page. Set to true to disable this feature.

This can be set globally in the [global configuration](/learn/docs/configuration/what-is-docs-yml#layout-configuration).
This can be set globally in the [global configuration](/learn/docs/configuration/site-level-settings#layout-configuration).
</ParamField>

<CodeBlock title="Example hide-feedback">
Expand Down Expand Up @@ -250,7 +250,7 @@ Currently, relative paths are _not_ supported for this field.
## SEO metadata

<Note title="Looking to set metadata across the entire site?">
[Use the metadata field in the `docs.yml` file](/learn/docs/configuration/what-is-docs-yml#seo-metadata-configuration).
[Use the metadata field in the `docs.yml` file](/learn/docs/configuration/site-level-settings#seo-metadata-configuration).
</Note>

<Markdown src="/snippets/seo-metadata-page.mdx" />
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Docs.yml"
subtitle: "Customize your documentation using the docs.yml file"
title: "Customize your site using docs.yml"
subtitle: "Set theming, redirects, and more"
description: "Learn how to configure your Fern documentation site with the docs.yml file. Customize colors, typography, layout, analytics and more."
max-toc-depth: 2
---
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
</div>
</a>

<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/configuration/what-is-docs-yml">
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/configuration/site-level-settings">
<div class="flex items-start flex-col space-y-3">
<img class="mx-auto dark:hidden" alt="Configure with ease" src="./images/configure.png" />
<img class="mx-auto hidden dark:block" alt="Configure with ease" src="./images/configure-dark.png" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The `assets` folder contains any images or videos used in your documentation. Yo

The `docs.yml` file is the heart of your Fern documentation site. This configuration file controls your documentation's navigation structure, visual design, site functionality, and hosting settings.

For complete configuration options, see the [docs.yml reference](/docs/configuration/what-is-docs-yml).
For complete configuration options, see the [docs.yml reference](/docs/configuration/site-level-settings).

<CodeBlock title="fern/docs.yml of this website">
```yml
Expand Down Expand Up @@ -180,6 +180,6 @@ title: Fern's Documentation

## `fern.config.json`

<Markdown src="/snippets/fern-config-json-reference.mdx" />
<Markdown src="/snippets/fern-config-json-reference.mdx" />


4 changes: 2 additions & 2 deletions fern/products/docs/pages/navigation/products.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ If your product-specific `.yml` files for **versioned products** includes a `nav

### Add instance audiences

Control which versions and/or products appear in each [documentation instance](/docs/configuration/what-is-docs-yml#instances-configuration) by tagging them with audiences. This enables separate sites for different user groups (e.g., internal developers, beta testers, public customers).
Control which versions and/or products appear in each [documentation instance](/docs/configuration/site-level-settings#instances-configuration) by tagging them with audiences. This enables separate sites for different user groups (e.g., internal developers, beta testers, public customers).

Content is filtered based on audience tags:

Expand Down Expand Up @@ -345,4 +345,4 @@ The dropdown menus for product and version selectors can be customized using the
<img src="webflow-version-selector.avif" alt="Example of a styled version selector" />
</Frame>
</Tab>
</Tabs>
</Tabs>
2 changes: 1 addition & 1 deletion fern/products/docs/pages/navigation/tabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Here's an example of how a tabs implementation renders:

### Tabs placement

Tabs display in the left sidebar by default. To display them horizontally, set `tabs-placement` to `header` in your [layout configuration](/docs/configuration/what-is-docs-yml#layout-configuration).
Tabs display in the left sidebar by default. To display them horizontally, set `tabs-placement` to `header` in your [layout configuration](/docs/configuration/site-level-settings#layout-configuration).

<CodeBlock title="docs.yml">
```yaml
Expand Down
4 changes: 2 additions & 2 deletions fern/products/docs/pages/navigation/versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ If your `docs.yml` file includes a `navigation` field or a `tabs` field, be sure
</Step>
<Step title="Add instance audiences">

Control which versions appear in each [documentation instance](/docs/configuration/what-is-docs-yml#instances-configuration) by tagging them with audiences. This enables separate sites for different user groups (e.g., internal developers, beta testers, public customers).
Control which versions appear in each [documentation instance](/docs/configuration/site-level-settings#instances-configuration) by tagging them with audiences. This enables separate sites for different user groups (e.g., internal developers, beta testers, public customers).

Content is filtered based on audience tags:

Expand Down Expand Up @@ -139,4 +139,4 @@ The dropdown menu for the version selector can be customized using the `fern-ver

<Frame>
<img src="webflow-version-selector.avif" alt="Example of a styled version selector" />
</Frame>
</Frame>
8 changes: 4 additions & 4 deletions fern/products/docs/pages/resources/stainless-comparison.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Choose Fern for enterprise requirements, regulated industries, or production-cri
|------------|------|-----------|
| **Maturity** | Production-ready, stable APIs | Early access, breaking changes expected |
| **Authoring** | [Visual editor](/learn/docs/writing-content/fern-editor) + Git | Git only |
| **Enterprise features** | [RBAC](/learn/docs/authentication/rbac), [SSO](/learn/docs/authentication/sso), [versioning](/learn/docs/configuration/what-is-docs-yml) | None |
| **Enterprise features** | [RBAC](/learn/docs/authentication/rbac), [SSO](/learn/docs/authentication/sso), [versioning](/learn/docs/configuration/site-level-settings) | None |
| **API testing** | [Interactive explorer](/learn/docs/api-references/api-explorer/overview) | None |
| **Deployment** | Cloud + [full-stack self-hosted](/learn/docs/self-hosted/overview) | Static files only |

Expand Down Expand Up @@ -58,13 +58,13 @@ Stainless doesn't provide an interactive testing environment. Fern's [API Explor

<Accordion title="RBAC, versioning, and multi-product support">

Stainless doesn't currently offer audience-specific content filtering, multi-version APIs, or unified multi-product sites. Fern provides [RBAC](/learn/docs/authentication/rbac) and [versioning](/learn/docs/configuration/what-is-docs-yml) capabilities for complex API portfolios.
Stainless doesn't currently offer audience-specific content filtering, multi-version APIs, or unified multi-product sites. Fern provides [RBAC](/learn/docs/authentication/rbac) and [versioning](/learn/docs/configuration/site-level-settings) capabilities for complex API portfolios.
Copy link
Contributor

Choose a reason for hiding this comment

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

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


| Feature | Fern Docs | Stainless Docs |
|---------|-----------|----------------|
| **RBAC** | ✅ [Audience-based content filtering](/learn/docs/authentication/rbac) for internal vs. public sites | ❌ None |
| **API versioning** | ✅ [Multi-version support](/learn/docs/configuration/what-is-docs-yml) with availability states and per-version content | ❌ None |
| **Multi-product sites** | ✅ [Multiple products](/learn/docs/configuration/what-is-docs-yml) in unified documentation | ⚠️ Basic tabs (Guides/Reference) |
| **API versioning** | ✅ [Multi-version support](/learn/docs/configuration/site-level-settings) with availability states and per-version content | ❌ None |
| **Multi-product sites** | ✅ [Multiple products](/learn/docs/configuration/site-level-settings) in unified documentation | ⚠️ Basic tabs (Guides/Reference) |
<br/>
</Accordion>

Expand Down
4 changes: 2 additions & 2 deletions fern/products/docs/pages/seo/metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Fern automatically generates all SEO metadata for every page in your documentati
When you do want to customize SEO settings, you can set defaults [at the site level](#website-metadata) or override them on [individual pages](#page-level-configuration). Keep titles between 50-60 characters and descriptions between 150-160 characters for optimal display.

<Note>
The metadata configurations on this page are for SEO and social tags that aren't visible to users. For visible footer links, see [footer links configuration](/learn/docs/configuration/what-is-docs-yml#footer-links-configuration).
The metadata configurations on this page are for SEO and social tags that aren't visible to users. For visible footer links, see [footer links configuration](/learn/docs/configuration/site-level-settings#footer-links-configuration).
</Note>

## How it works
Expand Down Expand Up @@ -53,7 +53,7 @@ For every page, Fern creates these SEO tags in your HTML:

## Website metadata

Set default SEO metadata for your entire documentation site in [`docs.yml`](/docs/configuration/what-is-docs-yml). These settings apply to all pages unless overridden by page-specific metadata.
Set default SEO metadata for your entire documentation site in [`docs.yml`](/docs/configuration/site-level-settings). These settings apply to all pages unless overridden by page-specific metadata.

<Markdown src="/snippets/seo-metadata-site.mdx" />

Expand Down
2 changes: 1 addition & 1 deletion fern/snippets/redirects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ redirects:
destination: / # Don't do this
```

Instead, [enable automatic homepage redirects in your `docs.yml`](/docs/configuration/what-is-docs-yml#settings-configuration) to send broken links to your homepage rather than showing a 404 page:
Instead, [enable automatic homepage redirects in your `docs.yml`](/docs/configuration/site-level-settings#settings-configuration) to send broken links to your homepage rather than showing a 404 page:

```yaml title="docs.yml"
settings:
Expand Down
Loading