Improve fern.config.json documentation #1548
Conversation
- Create comprehensive snippet for fern.config.json reference - Update all project structure pages to reference the snippet - Fix hard-coded CLI version in API definitions page - Add cross-references in CLI commands page - Use plant-themed examples per documentation guidelines Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,57 @@ | |||
| ## What is fern.config.json? | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'what's' instead of 'What is'.
| @@ -0,0 +1,57 @@ | |||
| ## What is fern.config.json? | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.HeadingPunctuation] Don't use end punctuation in headings.
|
|
||
| ### When to change these values | ||
|
|
||
| - **`organization`**: Rarely needs to be changed. Only update this if your organization identifier changes in the Fern Dashboard. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'Rarely' if it's not important to the meaning of the statement.
|
|
||
| - **`organization`**: Rarely needs to be changed. Only update this if your organization identifier changes in the Fern Dashboard. | ||
|
|
||
| - **`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. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
| The following CLI commands read from `fern.config.json`: | ||
|
|
||
| - **`fern check`**: Validates the configuration file | ||
| - **`fern upgrade`**: Updates the `version` field to the latest CLI version |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
| - **`fern check`**: Validates the configuration file | ||
| - **`fern upgrade`**: Updates the `version` field to the latest CLI version | ||
| - **`fern token`**: Uses the `organization` field to generate organization-specific tokens | ||
| - **`fern init`**: Creates this file when initializing a new project |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'new' that become outdated
- 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 <devinannlogan@gmail.com>
| @@ -0,0 +1,57 @@ | |||
| ## fern.config.json reference | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'fern.config.json reference' should use sentence-style capitalization.
| The following CLI commands read from `fern.config.json`: | ||
|
|
||
| - **`fern check`**: Validates the configuration file | ||
| - **`fern upgrade`**: Updates the `version` field to the current CLI version |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'current' that become outdated
- Reduce from 58 lines to 11 lines - Remove CLI commands list and 'When to change' section - Simplify to single example instead of tabs - Keep only essential information per user feedback Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Improve fern.config.json documentation
Summary
Created comprehensive centralized documentation for
fern.config.jsonto address inconsistencies and gaps across the documentation. The main changes:Created new snippet:
fern/snippets/fern-config-json-reference.mdxcontaining complete reference documentation for fern.config.json including:Updated project structure pages: Replaced inline fern.config.json documentation with snippet references in:
Fixed inconsistencies:
Added cross-references: Added links to fern.config.json reference in CLI commands page (fern check, fern upgrade, fern token) and other relevant pages
Review & Testing Checklist for Human
#fernconfigjson- the heading hierarchy has## What is fern.config.json?nested under### fern.config.jsonsections which might affect anchor generation/learn/cli-api/cli-reference/overview#install-fern-cli-locallyreferenced in the snippet<Markdown src="/snippets/version-number-cli.mdx"/>) renders correctly inline within the JSON code examplesTest Plan
fern checkto validate no broken links or configuration issuesNotes