Skip to content

Commit 228c9f9

Browse files
Fix Vale style warnings
- Change heading from 'What is fern.config.json?' to 'fern.config.json reference' - Remove 'Rarely' adverb from organization field description - Replace 'latest' with 'current' to avoid time-relative terms - Replace 'new project' with 'project' to avoid time-relative terms Co-Authored-By: Devin Logan <[email protected]>
1 parent 35736d6 commit 228c9f9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

fern/snippets/fern-config-json-reference.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## What is fern.config.json?
1+
## fern.config.json reference
22

33
Every `fern/` folder contains a single `fern.config.json` file at its root. This configuration file stores your organization name and the Fern CLI version used for your project.
44

@@ -41,17 +41,17 @@ Using `"*"` tells Fern to use your locally installed CLI version. This is useful
4141

4242
### When to change these values
4343

44-
- **`organization`**: Rarely needs to be changed. Only update this if your organization identifier changes in the Fern Dashboard.
44+
- **`organization`**: Only update this if your organization identifier changes in the Fern Dashboard.
4545

46-
- **`version`**: Use the `fern upgrade` command to update to the latest CLI version. The command automatically updates this field in `fern.config.json` and upgrades generators in `generators.yml` to their minimum-compatible versions.
46+
- **`version`**: Use the `fern upgrade` command to update the CLI version. The command automatically updates this field in `fern.config.json` and upgrades generators in `generators.yml` to their minimum-compatible versions.
4747

4848
### How the CLI uses this file
4949

5050
The following CLI commands read from `fern.config.json`:
5151

5252
- **`fern check`**: Validates the configuration file
53-
- **`fern upgrade`**: Updates the `version` field to the latest CLI version
53+
- **`fern upgrade`**: Updates the `version` field to the current CLI version
5454
- **`fern token`**: Uses the `organization` field to generate organization-specific tokens
55-
- **`fern init`**: Creates this file when initializing a new project
55+
- **`fern init`**: Creates this file when initializing a project
5656

5757
The version pinning ensures determinism across different environments. When you run any Fern CLI command, it automatically downloads and uses the specified CLI version, ensuring consistent behavior in local development, CI/CD pipelines, and across team members.

0 commit comments

Comments
 (0)