Skip to content

Commit 5e5f355

Browse files
committed
small updates to various pages
1 parent d48790a commit 5e5f355

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

fern/products/api-def/pages/project-structure.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@ description: Describes the Fern folder structure
44
---
55

66
Configuring fern starts with the `fern` folder. The fern folder contains your API definitions,
7-
generators, and your CLI version.
7+
SDK generators, and your CLI version.
88

99
## Directory structure
1010

11-
When you run `fern init` (for the Fern Definition) or `fern init --spec-type path/to/spec`, your fern folder will be initialized with the following files:
11+
When you run `fern init` (for the Fern Definition) or `fern init --spec-type path/to/spec` (for other specs), your fern folder is initialized with the following files:
1212

1313
```bash
1414
fern/
15-
├─ fern.config.json # Root-level configuration for entire Fern project
16-
├─ generators.yml # Defines what SDKs and docs to generate from your API
17-
└─ spec-folder/ # definition, openapi, asyncapi, etc
15+
├─ fern.config.json # Root-level config for entire Fern project
16+
├─ generators.yml # Defines SDKs and docs to generate
17+
└─ spec-folder/ # definition, openapi, asyncapi, etc.
1818
└─ spec-file.yml # API specification file
1919
```
2020

2121
<Info>
2222
For Fern Definition, your API configuration is split across two files: `api.yml` for API-wide configuration and separate `.yml` files for your actual endpoint and type definitions. See [What is a Fern Definition?](/api-definitions/ferndef/overview) for more information.
2323

24-
For other specification formats (OpenAPI, AsyncAPI), you'll have a single self-contained specification file.
24+
For the other specification formats ([OpenAPI](/api-definitions/openapi/overview), [AsyncAPI](/api-definitions/asyncapi/overview), [OpenRPC](/api-definitions/openrpc/overview), and [gRPC](/api-definitions/grpc/overview)), you'll have a single self-contained specification file.
2525
</Info>
2626

2727
<AccordionGroup>
@@ -55,12 +55,12 @@ api:
5555
5656
The fern folder can house multiple API definitions. When you have multiple APIs, nest your definition files within an `apis` folder.
5757

58-
Each API must also have a separate `generators.yml` file that specifies the location of the API definition and contains information about that API's SDKs.
58+
Each API must also have a separate `generators.yml` file that specifies the location of the API definition and configures SDK generation.
5959

6060
```bash
6161
fern/
6262
├─ fern.config.json
63-
├─ generators.yml # Optional: contains top-level configuration for all APIs
63+
├─ generators.yml # Optional: top-level configuration for all APIs
6464
└─ apis/
6565
└─ first-api/ # First API
6666
├─ generators.yml # Required: points to API spec

fern/products/api-def/pages/what-is-an-api-definition.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,9 +322,9 @@ Fern integrates with several API definition formats:
322322

323323
## Why create an API definition?
324324

325-
Once you have an API definition, Fern will use it as an input to generate artifacts
325+
Once you have an API definition, Fern uses it as an input to generate artifacts
326326
like SDKs and API Reference documentation. Every time you update the API definition,
327-
you can regenerate these artifacts and ensure they are always up-to-date.
327+
you can regenerate these artifacts to ensure they are always up-to-date.
328328

329329
<CardGroup cols={2}>
330330
<Card

0 commit comments

Comments
 (0)