From 8687369b6ecf1e0fb9f18159f22ecb12aab8d5d5 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 26 Nov 2025 17:46:15 -0500 Subject: [PATCH 1/4] structure revamp --- .../docs/pages/getting-started/quickstart.mdx | 230 +++++++++--------- 1 file changed, 115 insertions(+), 115 deletions(-) diff --git a/fern/products/docs/pages/getting-started/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx index dfed9bf18..311acff50 100644 --- a/fern/products/docs/pages/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/getting-started/quickstart.mdx @@ -1,105 +1,117 @@ --- title: Quickstart -subtitle: Start building beautiful documentation in under 5 minutes +description: 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). +With Fern, you can build beautiful developer documentation that [matches your brand](https://buildwithfern.com/customers). 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. + + 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. + - - - 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, once you have [The Fern CLI](/learn/cli-api-reference/cli-reference/overview) installed, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation: + + + Install the [Fern CLI](/learn/cli-api-reference/cli-reference/overview) so you can manage your project from the command line: - ```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 + ``` + + - ```bash - npm install -g fern-api - ``` + All the configuration for your docs live in the `fern` folder. Create a fern folder by using the [starter template](https://github.com/fern-api/docs-starter) or starting from scratch: - Then run + + - ```bash - fern init --docs + + ```bash title="SSH" + git clone git@github.com:fern-api/docs-starter.git ``` - - You will see a new `fern` folder in your project with the following structure: - - - - - - - - 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 + ```bash title="HTTPS" + git clone https://github.com/fern-api/docs-starter.git ``` - + + + This creates a basic site with an API definition, Markdown pages, and configuration files: + + + + + + + + + + + + + + ```bash + fern init --docs + ``` + + You'll see a new `fern` folder in your project with the following structure: + + + + + + + + + + + + The [`docs.yml`](/learn/docs/getting-started/project-structure#docsyml) and [`fern.config.json`](/learn/docs/getting-started/project-structure#fernconfigjson) files configure your site navigation and organization settings. Update your organization name in both places: + + + ```json {2} + { + "organization": "{{YOUR_ORGANIZATION}}", + "version": "" + } + ``` + + + ```yml {2} + instances: + - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com + ``` + + + + Navigate to the directory that contains your `fern` folder, and generate your documentation: - + ```bash + fern generate --docs + ``` + + This builds your documentation at `https://YourOrganization.docs.buildwithfern.com`, where `YourOrganization` is the name you defined in the `fern.config.json` file. + + + + + ## Update your docs - ### Update your docs + Once you have a basic docs site, start customizing it. Add tutorials, generate an API Reference, or finetune your site's branding. - We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it - [here](https://buildwithfern.com/contact). + Fern provides a white-glove migration service as part of the Enterprise plan. Interested? + [Reach out to us here](https://buildwithfern.com/contact). - Add content with MDX files. + Create [Markdown (`.mdx`) files](/learn/docs/writing-content/markdown-basics) and fill them in. + + + Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required. + - ```markdown + ```markdown docs/pages/hello-world.mdx --- title: "Page Title" description: "Subtitle (optional)" @@ -108,14 +120,10 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. 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. + Reference your new pages from your `docs.yml` file. You can reference the + Markdown page within a section or as a standalone page. - ```yml + ```yml docs.yml navigation: - page: Hello World path: docs/pages/hello-world.mdx @@ -126,28 +134,25 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. ``` - Add an API Reference by adding an OpenAPI Specification to your project. + Add an API definition 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. + This will create an `openapi.yml` file in your project. Then, reference this file in your + `docs.yml` file to generate API Reference documentation: - ```yml + ```yml docs.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: + Configure all of your site's branding in the `docs.yml` file. For example, to set the logos, colors, and fonts for your docs: - ```yml + ```yml maxLines=7 colors: accent-primary: dark: "#f0c193" @@ -164,42 +169,37 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. - - ### Preview your docs + ## Preview your docs + + Before publishing, you can view your docs locally, in shared preview links, or in a PR. + - You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally). + [Preview your docs locally](/docs/preview-publish/previewing-changes-locally) for testing purposes in your local development environment or using shareable preview links. - `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). + [Preview changes from pull requests (PRs)](/docs/preview-publish/previewing-changes-in-a-pr) before merging code to a production branch. - ### Publish to production + ## Publish to production + + Publish your docs publically, then configure hosting and analytics. - 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) + When you're ready for your docs to be publicly accessible, [publish them using the Fern CLI](/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 hosting your docs website on a [custom domain or on a + custom subpath](/learn/docs/preview-publish/setting-up-your-domain) (e.g. `https://example.com/docs`). - 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). + Fern supports integrations with a [variety of + providers](/learn/docs/integrations/overview) such as PostHog, Segment, + Intercom, and Google Tag Manager, etc. - - - -[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 427644f7b7e782e670cfaee96013b3ca279faf73 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 1 Dec 2025 13:49:42 -0500 Subject: [PATCH 2/4] formatting updates --- .../docs/pages/getting-started/quickstart.mdx | 68 +++++++++++++++---- 1 file changed, 53 insertions(+), 15 deletions(-) diff --git a/fern/products/docs/pages/getting-started/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx index 311acff50..aa42213f2 100644 --- a/fern/products/docs/pages/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/getting-started/quickstart.mdx @@ -3,21 +3,23 @@ title: Quickstart description: Start building beautiful documentation in under 5 minutes --- -With Fern, you can build beautiful developer documentation that [matches your brand](https://buildwithfern.com/customers). Fern supports writing pages (written in Markdown) and generating API Reference documentation (from an OpenAPI Specification). +Build beautiful developer documentation that [matches your brand](https://buildwithfern.com/customers) with Fern. Fern supports writing pages 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. +Follow this guide to get started with Fern in under 5 minutes. - - 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. - +## Get started with Fern Docs + Install the [Fern CLI](/learn/cli-api-reference/cli-reference/overview) so you can manage your project from the command line: ```bash npm install -g fern-api ``` + + 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. + @@ -35,7 +37,7 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. ``` - This creates a basic site with an API definition, Markdown pages, and configuration files: + Cloning the template creates a basic site with an API definition, Markdown pages, and configuration files. You can use these files to test out Fern's site offerings, or replace them with your own files. @@ -53,7 +55,7 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. fern init --docs ``` - You'll see a new `fern` folder in your project with the following structure: + You'll see a new `fern` folder in your project with the following configuration files (but no additional Markdown or API definition files): @@ -99,13 +101,13 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. Once you have a basic docs site, start customizing it. Add tutorials, generate an API Reference, or finetune your site's branding. - Fern provides a white-glove migration service as part of the Enterprise plan. Interested? - [Reach out to us here](https://buildwithfern.com/contact). + Fern provides a white-glove migration service as part of the Enterprise plan. + [Reach out here](https://buildwithfern.com/contact). - Create [Markdown (`.mdx`) files](/learn/docs/writing-content/markdown-basics) and fill them in. + Create Markdown (`.mdx`) files and fill them in. Read the [Markdown basics](/learn/docs/writing-content/markdown-basics) documentation to learn more. Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required. @@ -140,7 +142,7 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. fern init --openapi /path/to/openapi.yml ``` - This will create an `openapi.yml` file in your project. Then, reference this file in your + This creates an `openapi.yml` file in your project. Reference this file in your `docs.yml` file to generate API Reference documentation: ```yml docs.yml @@ -149,7 +151,7 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. ``` - Configure all of your site's branding in the `docs.yml` file. For example, to set the logos, colors, and fonts for your docs: + [Configure all of your site's branding](/learn/docs/configuration/site-level-settings), such as the logo, colors, and font, in the `docs.yml` file. ```yml maxLines=7 @@ -173,7 +175,7 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. ## Preview your docs - Before publishing, you can view your docs locally, in shared preview links, or in a PR. + You can view your docs locally, in shared preview links, or in a PR before publishing. @@ -199,7 +201,43 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. Fern supports integrations with a [variety of providers](/learn/docs/integrations/overview) such as PostHog, Segment, - Intercom, and Google Tag Manager, etc. + Intercom, and Google Tag Manager. - + + ## Next steps + + + + Use the `docs.yml` file to configure colors, SEO, typography, layouts, and more. + + + Use Fern's built-in components to create interactive, well-organized documentation. + + + Add products, versions, nested sections, tabs, and more. + + + Finetune your generated API Reference section. + + + + + + From bb0c60834a8f6857e510b5ca2476bcbc13cd7cd6 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 3 Dec 2025 13:36:00 -0500 Subject: [PATCH 3/4] refactor --- .../docs/pages/getting-started/quickstart.mdx | 337 ++++++++++-------- 1 file changed, 180 insertions(+), 157 deletions(-) diff --git a/fern/products/docs/pages/getting-started/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx index aa42213f2..e7bdecf1e 100644 --- a/fern/products/docs/pages/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/getting-started/quickstart.mdx @@ -3,30 +3,29 @@ title: Quickstart description: Start building beautiful documentation in under 5 minutes --- -Build beautiful developer documentation that [matches your brand](https://buildwithfern.com/customers) with Fern. Fern supports writing pages in Markdown and generating API Reference documentation from an OpenAPI Specification. +Build beautiful developer documentation that [matches your brand](https://buildwithfern.com/customers) with Fern. Fern supports writing pages in Markdown and generating API Reference documentation from an OpenAPI Specification. Follow this guide to get started with Fern in under 5 minutes. -## Get started with Fern Docs + + Migrating from existing documentation? Fern provides a white-glove migration service as part of the Enterprise plan. [Reach out here](https://buildwithfern.com/contact). + - - + + - Install the [Fern CLI](/learn/cli-api-reference/cli-reference/overview) so you can manage your project from the command line: + Install the [Fern CLI](/learn/cli-api-reference/cli-reference/overview) so you can manage your project from the command line: - ```bash - npm install -g fern-api - ``` - - 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. - + ```bash + npm install -g fern-api + ``` - All the configuration for your docs live in the `fern` folder. Create a fern folder by using the [starter template](https://github.com/fern-api/docs-starter) or starting from scratch: + All the configuration for your docs lives in the `fern` folder. Create a fern folder by either using the [starter template](https://github.com/fern-api/docs-starter) or starting from scratch - - + + ```bash title="SSH" @@ -37,19 +36,35 @@ Follow this guide to get started with Fern in under 5 minutes. ``` - Cloning the template creates a basic site with an API definition, Markdown pages, and configuration files. You can use these files to test out Fern's site offerings, or replace them with your own files. + You'll see a basic site with a `fern` folder that contains an API definition, Markdown pages, and configuration files. [View the live example](https://plantstore.dev/welcome) to see what the starter template looks like when published. You can use these files to test out Fern's features, or replace them with your own files. - - - - - + + + + + + + + + + + + + + + + + + + + + - - + + ```bash fern init --docs @@ -59,185 +74,193 @@ Follow this guide to get started with Fern in under 5 minutes. - - + + - - - - - The [`docs.yml`](/learn/docs/getting-started/project-structure#docsyml) and [`fern.config.json`](/learn/docs/getting-started/project-structure#fernconfigjson) files configure your site navigation and organization settings. Update your organization name in both places: - - - ```json {2} - { - "organization": "{{YOUR_ORGANIZATION}}", - "version": "" - } - ``` - - - ```yml {2} - instances: - - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com - ``` - - - - Navigate to the directory that contains your `fern` folder, and generate your documentation: - - ```bash - fern generate --docs - ``` - - This builds your documentation at `https://YourOrganization.docs.buildwithfern.com`, where `YourOrganization` is the name you defined in the `fern.config.json` file. - - - - - ## Update your docs + + + + - Once you have a basic docs site, start customizing it. Add tutorials, generate an API Reference, or finetune your site's branding. + The [`docs.yml`](/learn/docs/getting-started/project-structure#docsyml) and [`fern.config.json`](/learn/docs/getting-started/project-structure#fernconfigjson) files configure your site navigation and organization settings. Update your organization name in both places. - Fern provides a white-glove migration service as part of the Enterprise plan. - [Reach out here](https://buildwithfern.com/contact). + Use only alphanumeric characters, hyphens, and underscores for your organization name. + + ```json {2} + { + "organization": "{{YOUR_ORGANIZATION}}", + "version": "" + } + ``` + + + ```yml {2} + instances: + - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com + ``` + + + + + Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or finetuning the branding. (Or skip ahead to [preview](#preview-your-docs) and [publish](#publish-to-production).) + - Create Markdown (`.mdx`) files and fill them in. Read the [Markdown basics](/learn/docs/writing-content/markdown-basics) documentation to learn more. - - - Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required. - - - ```markdown docs/pages/hello-world.mdx - --- - title: "Page Title" - description: "Subtitle (optional)" - --- - - Hello world! - ``` - Reference your new pages from your `docs.yml` file. You can reference the - Markdown page within a section or as a standalone page. - - ```yml docs.yml - navigation: - - page: Hello World - path: docs/pages/hello-world.mdx - - section: Overview - contents: - - page: QuickStart - path: docs/pages/hello-world.mdx - ``` + Create Markdown (`.mdx`) files and fill them in. Read the [Markdown basics](/learn/docs/writing-content/markdown-basics) documentation to learn more. + + + Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required. You can also create [reusable snippets](/learn/docs/writing-content/reusable-snippets) to share content across multiple pages. + + + ```markdown docs/pages/hello-world.mdx + --- + title: "Page Title" + description: "Subtitle (optional)" + --- + + Hello world! + ``` + + Reference your new pages from your `docs.yml` file. You can reference the + Markdown page within a section or as a standalone page. + + ```yml docs.yml + navigation: + - page: Hello World + path: docs/pages/hello-world.mdx + - section: Overview + contents: + - page: Getting Started + path: docs/pages/getting-started.mdx + ``` - Add an API definition to your project: - ```bash - fern init --openapi /path/to/openapi.yml - ``` + If you cloned the starter template, you already have an `openapi.yaml` file with sample API definitions. If you started from scratch, add your OpenAPI spec: - This creates an `openapi.yml` file in your project. Reference this file in your - `docs.yml` file to generate API Reference documentation: + ```bash + fern init --openapi /path/to/openapi.yml + ``` - ```yml docs.yml - navigation: - - api: "API Reference" - ``` + Reference your API definition in the `docs.yml` file to [generate API Reference documentation](/learn/docs/api-references/generate-api-ref): + + ```yml docs.yml + navigation: + - api: "API Reference" + ``` - [Configure all of your site's branding](/learn/docs/configuration/site-level-settings), such as the logo, colors, and font, in the `docs.yml` file. - - - ```yml maxLines=7 - 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 + [Configure all of your site's branding](/learn/docs/configuration/site-level-settings), such as the logo, colors, and font, in the `docs.yml` file. - You can view your docs locally, in shared preview links, or in a PR before publishing. + + ```yml maxLines=7 + colors: + accent-primary: + dark: "#f0c193" + light: "#af5f1b" - - - [Preview your docs locally](/docs/preview-publish/previewing-changes-locally) for testing purposes in your local development environment or using shareable preview links. - - - [Preview changes from pull requests (PRs)](/docs/preview-publish/previewing-changes-in-a-pr) before merging code to a production branch. + logo: + dark: docs/assets/logo-dark.svg + light: docs/assets/logo-light.svg + height: 40 + href: https://buildwithfern.com/ + + favicon: docs/assets/favicon.svg + ``` + - - ## Publish to production + + - Publish your docs publically, then configure hosting and analytics. + Before publishing, [preview your changes](/docs/preview-publish/previewing-changes-locally) in your local development environment or generate shareable preview links. - - - When you're ready for your docs to be publicly accessible, [publish them using the Fern CLI](/learn/docs/preview-publish/publishing-your-docs). - - - Fern supports hosting your docs website on a [custom domain or on a - custom subpath](/learn/docs/preview-publish/setting-up-your-domain) (e.g. `https://example.com/docs`). - - - Fern supports integrations with a [variety of - providers](/learn/docs/integrations/overview) such as PostHog, Segment, - Intercom, and Google Tag Manager. - - + + + + Run the local development server with hot-reloading. Your docs will automatically update as you edit Markdown and OpenAPI files: + + ```bash + fern docs dev + ``` + + + + Generate a preview URL you can share with your team: + + ```bash + fern generate --docs --preview + ``` + + + + + + When you're ready for your docs to be publicly accessible, [publish them](/learn/docs/preview-publish/publishing-your-docs): + + ```bash + fern generate --docs + ``` + + This command builds your documentation at `https://YourOrganization.docs.buildwithfern.com`, where `YourOrganization` is the name defined in `fern.config.json`. + + + Use the [Fern Dashboard](http://dashboard.buildwithfern.com) to manage your GitHub repository connection, organization members, and CLI version. Track analytics to understand how developers use your docs. + + + + +## Explore Fern's features - ## Next steps +Now that your docs are live, explore these features to enhance them further. - + - Use the `docs.yml` file to configure colors, SEO, typography, layouts, and more. + Use the `docs.yml` file to configure colors, SEO, typography, layouts, and more. - Use Fern's built-in components to create interactive, well-organized documentation. + Use Fern's built-in components to create interactive, well-organized documentation. - Add products, versions, nested sections, tabs, and more. + Add products, versions, nested sections, tabs, and more. - Finetune your generated API Reference section. + Use the Fern Editor to let non-technical team members edit docs in a WYSIWYG browser interface. - - - - - + + Host your docs on your own domain or subdomain (e.g., docs.example.com). + + + Integrate with PostHog, Segment, Intercom, Google Tag Manager, and other platforms. + + From fbe733bf5848891935f4d0b454246acd2bdfdeb2 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 3 Dec 2025 14:31:44 -0500 Subject: [PATCH 4/4] clarify org name per feedback --- .../docs/pages/getting-started/quickstart.mdx | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/fern/products/docs/pages/getting-started/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx index e7bdecf1e..3746effc4 100644 --- a/fern/products/docs/pages/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/getting-started/quickstart.mdx @@ -81,13 +81,13 @@ Follow this guide to get started with Fern in under 5 minutes. - + - The [`docs.yml`](/learn/docs/getting-started/project-structure#docsyml) and [`fern.config.json`](/learn/docs/getting-started/project-structure#fernconfigjson) files configure your site navigation and organization settings. Update your organization name in both places. + Configure two settings (these values don't have to match): + + - **Organization name** in `fern.config.json`: Identifies your organization in the Fern system (including the [Fern Dashboard](https://dashboard.buildwithfern.com/)) + - **Docs URL** in `docs.yml`: Determines where your docs are published - - Use only alphanumeric characters, hyphens, and underscores for your organization name. - ```json {2} @@ -100,9 +100,13 @@ Follow this guide to get started with Fern in under 5 minutes. ```yml {2} instances: - - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com + - url: {{YOUR_DOMAIN}}.docs.buildwithfern.com ``` + + + Use only alphanumeric characters, hyphens, and underscores for both values. + @@ -208,7 +212,7 @@ Follow this guide to get started with Fern in under 5 minutes. fern generate --docs ``` - This command builds your documentation at `https://YourOrganization.docs.buildwithfern.com`, where `YourOrganization` is the name defined in `fern.config.json`. + This command builds your documentation at the URL you configured in `docs.yml` (e.g., `https://yourdomain.docs.buildwithfern.com`). Use the [Fern Dashboard](http://dashboard.buildwithfern.com) to manage your GitHub repository connection, organization members, and CLI version. Track analytics to understand how developers use your docs.