From bc216bd36d84d9a64bac95ce891e2c806d0d814d Mon Sep 17 00:00:00 2001
From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com>
Date: Thu, 30 Oct 2025 19:17:08 +0000
Subject: [PATCH 1/2] Fern Editor: Update
---
fern/products/docs/docs.yml | 15 +-
.../docs/pages/getting-started/quickstart.mdx | 204 ------------------
2 files changed, 6 insertions(+), 213 deletions(-)
delete mode 100644 fern/products/docs/pages/getting-started/quickstart.mdx
diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml
index 4dfdeed4..11c5166e 100644
--- a/fern/products/docs/docs.yml
+++ b/fern/products/docs/docs.yml
@@ -5,8 +5,6 @@ navigation:
path: ./pages/getting-started/overview.mdx
- page: How it works
path: ./pages/getting-started/how-it-works.mdx
- - page: Quickstart
- path: ./pages/getting-started/quickstart.mdx
- page: Project structure
path: ./pages/getting-started/project-structure.mdx
- link: Customer showcase
@@ -130,7 +128,7 @@ navigation:
- section: Preview & publish
collapsed: true
contents:
- - page: Previewing changes locally
+ - page: Previewing changes locally
path: ./pages/getting-started/preview-changes-locally.mdx
- page: Previewing changes in a PR
path: ./pages/getting-started/pr-preview.mdx
@@ -218,9 +216,9 @@ navigation:
path: ./pages/api-references/autopopulate-api-key.mdx
- page: SSO
path: ./pages/authentication/sso.mdx
- - section: Self-hosted
- collapsed: true
- contents:
+ - section: Self-hosted
+ collapsed: true
+ contents:
- page: Overview
path: ./pages/enterprise/self-hosted.mdx
- page: Set up self-hosted documentation
@@ -253,7 +251,7 @@ navigation:
slug: analytics/mixpanel
- page: Postman
path: ./pages/integrations/postman.mdx
- - page: LaunchDarkly feature flags
+ - page: LaunchDarkly feature flags
path: ./pages/integrations/feature-flags.mdx
- section: Developer tools
collapsed: true
@@ -265,7 +263,6 @@ navigation:
- page: GitLab
path: ./pages/developer-tools/gitlab.mdx
- page: Vale
- path: ./pages/developer-tools/vale.mdx
+ path: ./pages/developer-tools/vale.mdx
- page: View Markdown
path: ./pages/developer-tools/view-markdown.mdx
-
\ No newline at end of file
diff --git a/fern/products/docs/pages/getting-started/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx
deleted file mode 100644
index 3226ce36..00000000
--- a/fern/products/docs/pages/getting-started/quickstart.mdx
+++ /dev/null
@@ -1,204 +0,0 @@
----
-title: Quickstart
-subtitle: Start building beautiful documentation in under 5 minutes
----
-
-With Fern, you can build beautiful developer documentation that matches your brand. Fern supports writing pages (written in Markdown) and generating API Reference documentation (from an OpenAPI Specification).
-
-In this guide, we'll show you how to get started with Fern in under 5 minutes.
-
-
- ### Initialize your `fern` folder
-
- All the configurations for your docs live in the `fern` folder. Inside, you'll
- find a `docs.yml` file that contains all the settings for your documentation.
-
-
-
- Get started by cloning the [starter template](https://github.com/fern-api/docs-starter).
-
-
- ```bash title="SSH"
- git clone git@github.com:fern-api/docs-starter.git
- ```
- ```bash title="HTTPS"
- git clone https://github.com/fern-api/docs-starter.git
- ```
-
-
- Next, please update the template settings to use your organization.
-
-
- Edit the details in `fern.config.json` and `docs.yml` with your organization
- name.
-
-
-
- ```json {2}
- {
- "organization": "{{YOUR_ORGANIZATION}}",
- "version": ""
- }
- ```
-
-
- ```yml {2}
- instances:
- - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com
- ```
-
-
-
- See the [fern.config.json reference](/learn/sdks/overview/project-structure#fernconfigjson) for more details.
-
- Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
-
- ```bash
- fern generate --docs
- ```
-
-
- If you prefer, you can use our CLI to create a new project. Install the CLI
- by running
-
- ```bash
- npm install -g fern-api
- ```
-
- Then run
-
- ```bash
- fern init --docs
- ```
-
- You will see a new `fern` folder in your project with the following structure:
-
- ```bash
- fern
- ├─ docs.yml
- └─ fern.config.json
- ```
- Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
-
- ```bash
- fern generate --docs
- ```
-
-
-
-
- ### Update your docs
-
-
- We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it
- [here](https://buildwithfern.com/contact).
-
-
-
-
- Add content with MDX files.
-
- ```markdown
- ---
- title: "Page Title"
- description: "Subtitle (optional)"
- ---
-
- Hello world!
- ```
-
-
- Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required.
-
-
- In order for the Markdown page to show up, you'll need to reference them from your `docs.yml` file. You
- can reference the Markdown page within a section or as a standalone page.
-
- ```yml
- navigation:
- - page: Hello World
- path: docs/pages/hello-world.mdx
- - section: Overview
- contents:
- - page: QuickStart
- path: docs/pages/hello-world.mdx
- ```
-
-
- Add an API Reference by adding an OpenAPI Specification to your project.
-
- ```bash
- fern init --openapi /path/to/openapi.yml
- ```
-
- This will create an `openapi.yml` file in your project. You can reference this file in your
- `docs.yml` file by adding an api block.
-
- ```yml
- navigation:
- - api: "API Reference"
- ```
-
-
- All of the branding for your docs can be configured in the `docs.yml` file.
-
- For example, to set the logos, colors, and fonts for your docs, you can
- add the following to your `docs.yml` file:
-
-
- ```yml
- colors:
- accent-primary:
- dark: "#f0c193"
- light: "#af5f1b"
-
- logo:
- dark: docs/assets/logo-dark.svg
- light: docs/assets/logo-light.svg
- height: 40
- href: https://buildwithfern.com/
-
- favicon: docs/assets/favicon.svg
- ```
-
-
-
-
-
-
- ### Preview your docs
-
-
- You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally).
-
-
- `PR previews` offer a way to preview changes from pull requests (PRs) before merging code to a production branch. Learn more [here](/docs/preview-publish/previewing-changes-in-a-pr).
-
-
-
- ### Publish to production
-
-
-
- When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI. [Read more.](/learn/docs/preview-publish/publishing-your-docs)
-
-
- Fern supports hosting your docs website on a custom domain or on a
- custom subpath (e.g. `https://example.com/docs`).
- Please reach out to the Fern team at support@buildwithfern.com to configure this.
-
-
- Fern supports integrations with a variety of providers such as PostHog, Segment, Intercom,
- Google Tag Manager, etc.
- Find out more on this [page](/learn/docs/integrations/overview).
-
-
-
-
-
-
-[View examples of documentation websites](https://buildwithfern.com/customers) that have been published using Fern.
-
-
- Use the [Fern Dashboard](http://dashboard.buildwithfern.com) to manage your GitHub repository connection, organization members (add or remove), and Fern CLI version. You can also view page views and unique visitors to your site.
-
From fa635a99c6752e962db74a902993f62e6196e031 Mon Sep 17 00:00:00 2001
From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com>
Date: Thu, 30 Oct 2025 19:17:50 +0000
Subject: [PATCH 2/2] Fern Editor: Update
---
fern/docs/pages/learn/docs/getting-started/one.mdx | 5 +++++
fern/docs/pages/learn/docs/getting-started/three.mdx | 5 +++++
fern/products/docs/docs.yml | 6 +++++-
3 files changed, 15 insertions(+), 1 deletion(-)
create mode 100644 fern/docs/pages/learn/docs/getting-started/one.mdx
create mode 100644 fern/docs/pages/learn/docs/getting-started/three.mdx
diff --git a/fern/docs/pages/learn/docs/getting-started/one.mdx b/fern/docs/pages/learn/docs/getting-started/one.mdx
new file mode 100644
index 00000000..17e5e874
--- /dev/null
+++ b/fern/docs/pages/learn/docs/getting-started/one.mdx
@@ -0,0 +1,5 @@
+---
+title: ONE
+slug: learn/docs/getting-started/one
+---
+
diff --git a/fern/docs/pages/learn/docs/getting-started/three.mdx b/fern/docs/pages/learn/docs/getting-started/three.mdx
new file mode 100644
index 00000000..523dc3ec
--- /dev/null
+++ b/fern/docs/pages/learn/docs/getting-started/three.mdx
@@ -0,0 +1,5 @@
+---
+title: THREE
+slug: learn/docs/getting-started/three
+---
+
diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml
index 11c5166e..ab4cb85d 100644
--- a/fern/products/docs/docs.yml
+++ b/fern/products/docs/docs.yml
@@ -1,5 +1,5 @@
navigation:
- - section: Getting started
+ - section: TWO
contents:
- page: Overview
path: ./pages/getting-started/overview.mdx
@@ -9,6 +9,10 @@ navigation:
path: ./pages/getting-started/project-structure.mdx
- link: Customer showcase
href: https://buildwithfern.com/showcase#docs-customers.alldocs-features
+ - page: ONE
+ path: docs/pages/learn/docs/getting-started/one.mdx
+ - page: THREE
+ path: docs/pages/learn/docs/getting-started/three.mdx
- changelog: ./pages/changelog
icon: fa-regular fa-clock-rotate-left
- section: Configuration