From 1aca4d2b436146f85776b6a1332398693551487e Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 16:47:34 +0000 Subject: [PATCH] Fern Editor: Update --- fern/products/docs/docs.yml | 13 +- .../getting-started/project-structure.mdx | 185 ------------------ 2 files changed, 6 insertions(+), 192 deletions(-) delete mode 100644 fern/products/docs/pages/getting-started/project-structure.mdx diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 4dfdeed4..6d5fab78 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -130,7 +130,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 +218,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 +253,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 +265,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/project-structure.mdx b/fern/products/docs/pages/getting-started/project-structure.mdx deleted file mode 100644 index 33ccd22d..00000000 --- a/fern/products/docs/pages/getting-started/project-structure.mdx +++ /dev/null @@ -1,185 +0,0 @@ ---- -title: Project Structure -description: An overview of the file and folder structure of a Fern Docs project ---- - -This page provides an overview of the file and folder structure of a Fern Docs project. The following structure is recommended for organizing your documentation content, but is customizable to fit your needs. - -## Top-level folders - - -```bash - fern - ├─ pages - ├─ assets - ├─ docs.yml - ├─ openapi - └─ fern.config.json -``` - - -A Fern Docs project has the following top-level folders: - -- `pages`: Contains the Markdown (MDX) files that make up your documentation. -- `assets`: Contains any images or videos used in your documentation. -- `docs.yml`: The configuration file that defines the navigation, theme, and hosting details of your documentation. -- `openapi`: Contains the OpenAPI Specification file (if you have an API Reference section in your documentation). -- `fern.config.json`: The configuration file specifying your organization name and CLI version. - -## Pages folder - -The `pages` folder contains the Markdown (MDX) files that make up your documentation. Each MDX file represents a page in your documentation. - - -```bash - pages - ├─ introduction - │ ├─ quickstart.mdx - │ ├─ project-structure.mdx - │ └─ showcase.mdx - ├─ building-your-docs - │ ├─ navigation - │ ├─ sections.mdx - │ ├─ tabs.mdx - │ └─ versions.mdx - └─ └─ configuration.mdx - -``` - - -The `pages` folder is organized into subfolders based on the sections of your documentation. Each subfolder contains the MDX files for the pages in that section. - -## Assets folder - -The `assets` folder contains any images or videos used in your documentation. You can reference these assets in your MDX files using relative paths. - - -```bash - assets - ├─ favicon.ico - ├─ product-screenshot.svg - ├─ demo-video.mp4 - ├─ logo-dark-mode.png - └─ logo-light-mode.png -``` - - -## `docs.yml` - -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). - - -```yml -instances: - - url: fern.docs.buildwithfern.com/learn - custom-domain: buildwithfern.com/learn - -navigation: - - section: Introduction - layout: - - page: QuickStart - path: pages/introduction/quickstart.mdx - - page: Project Structure - path: pages/introduction/project-structure.mdx - - page: Showcase - path: pages/introduction/showcase.mdx - -navbar-links: - - type: filled - text: Book a demo - url: https://buildwithfern.com/contact - -logo: - light: ./images/logo-primary.svg - dark: ./images/logo-white.svg - -colors: - accent-primary: - dark: "#ADFF8C" - light: "#209d63" - -favicon: ./images/favicon.ico - -title: Fern's Documentation -``` - - -## API Definitions - - - - The `openapi` folder contains the OpenAPI Specification file for your API Reference section. Fern will read either a YAML or JSON file from this folder to generate the API Reference documentation. If you don't have an API Reference section, you can skip this folder. - - In addition to your specification file, you can optionally [add an overrides file](/api-definitions/overview/overrides) for additional customizations. - - - ```bash - openapi - ├─ openapi.yaml # OR openapi.json - └─ overrides.yaml - ``` - - - To see this in practice, check out [Fluidstack's Fern configuration](https://github.com/fluidstackio/fern-config/tree/main/fern/openapi). - - - - The `definition` folder contains the Fern Definition YAML files used to generate the API Reference section. If you don't have an API Reference section, you can skip this folder. - - In addition to your specification file, you can optionally [add an overrides file](/api-definitions/overview/overrides) for additional customizations. - - - ```bash - definition - ├─ pets.yaml - ├─ owners.yaml - ├─ stores.yaml - ├─ overrides.yaml - └─ api.yaml - ``` - - - To see this in practice, check out [Cartesia's Fern configuration](https://github.com/cartesia-ai/docs/tree/main/fern/apis/version-2025-04-16/definition). - - - - If you have multiple APIs, you can organize them into separate folders within the `apis` folder. Each API should have its own API definition and [(optional) overrides file](/api-definitions/overview/overrides). - - For example: - - ```bash - apis - ├─ admin - │ ├─ openapi.json - │ └─ overrides.yaml - ├─ user - │ ├─ openapi.yaml - │ └─ overrides.yaml - ``` - - - To see this in practice, check out [Vapi's Fern configuration](https://github.com/VapiAI/docs/tree/main/fern/apis). - - - - - - If you're using Fern for both API Reference documentation and SDKs, you'll use both `docs.yml` (the Docs configuration file) and `generators.yml` ([the SDK configuration file](/sdks/overview/project-structure#generatorsyml)) to configure [how SDK code snippets appear](/docs/api-references/sdk-snippets) in your API reference documentation. - - If you're only using Fern for API Reference docs, not SDKs, your `generators.yml` should simply link to your spec: - - ```yaml title="generators.yml" - api: - specs: - - openapi: ../openapi/openapi.json - ``` - - - -## `fern.config.json` - - - -