Skip to content

Expand schema directive Tip on generators.yml reference page - #6825

Open
fern-api[bot] wants to merge 1 commit into
mainfrom
2026-09-02-fern-ai-d8be69-aec066dc
Open

Expand schema directive Tip on generators.yml reference page#6825
fern-api[bot] wants to merge 1 commit into
mainfrom
2026-09-02-fern-ai-d8be69-aec066dc

Conversation

@fern-api

@fern-api fern-api Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Updated the <Tip> callout near the top of fern/products/sdks/reference/generators-yml-reference.mdx to explain which editors support the yaml-language-server schema directive. The expanded tip now names VS Code (with a link to the YAML extension), Neovim, Emacs, and other YAML Language Server–powered editors, and adds a note for IntelliJ IDEA users explaining that IntelliJ doesn't read the directive natively and directing them to configure schema validation via Settings → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings. The existing code block showing the directive is unchanged.

@fern-api
fern-api Bot requested a review from devalog as a code owner September 2, 2026 20:24

<Tip>
To enable intelligent YAML validation and autocompletion in your editor, add a schema directive to the top of your `generators.yml` file.
To enable intelligent YAML validation and autocompletion in your editor, add a schema directive to the top of your `generators.yml` file. This directive is recognized by the [YAML Language Server](https://github.com/redhat-developer/yaml-language-server), which powers YAML support in **VS Code** (via the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)), **Neovim**, **Emacs**, and other editors that integrate the YAML Language Server. **IntelliJ IDEA** uses its own built-in YAML support and does not read the `yaml-language-server` directive natively; for schema validation in IntelliJ, configure the schema mapping in **Settings → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings** and point it to `https://schema.buildwithfern.dev/generators-yml.json`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <FernStyles.Acronyms> reported by reviewdog 🐶
'IDEA' has no definition.


<Tip>
To enable intelligent YAML validation and autocompletion in your editor, add a schema directive to the top of your `generators.yml` file.
To enable intelligent YAML validation and autocompletion in your editor, add a schema directive to the top of your `generators.yml` file. This directive is recognized by the [YAML Language Server](https://github.com/redhat-developer/yaml-language-server), which powers YAML support in **VS Code** (via the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)), **Neovim**, **Emacs**, and other editors that integrate the YAML Language Server. **IntelliJ IDEA** uses its own built-in YAML support and does not read the `yaml-language-server` directive natively; for schema validation in IntelliJ, configure the schema mapping in **Settings → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings** and point it to `https://schema.buildwithfern.dev/generators-yml.json`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'doesn't' instead of 'does not'.

Suggested change
To enable intelligent YAML validation and autocompletion in your editor, add a schema directive to the top of your `generators.yml` file. This directive is recognized by the [YAML Language Server](https://github.com/redhat-developer/yaml-language-server), which powers YAML support in **VS Code** (via the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)), **Neovim**, **Emacs**, and other editors that integrate the YAML Language Server. **IntelliJ IDEA** uses its own built-in YAML support and does not read the `yaml-language-server` directive natively; for schema validation in IntelliJ, configure the schema mapping in **Settings → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings** and point it to `https://schema.buildwithfern.dev/generators-yml.json`.
To enable intelligent YAML validation and autocompletion in your editor, add a schema directive to the top of your `generators.yml` file. This directive is recognized by the [YAML Language Server](https://github.com/redhat-developer/yaml-language-server), which powers YAML support in **VS Code** (via the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)), **Neovim**, **Emacs**, and other editors that integrate the YAML Language Server. **IntelliJ IDEA** uses its own built-in YAML support and doesn't read the `yaml-language-server` directive natively; for schema validation in IntelliJ, configure the schema mapping in **Settings → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings** and point it to `https://schema.buildwithfern.dev/generators-yml.json`.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-2026-09-02-fern-ai-d8be69-aec066dc.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants