Expand generators.yml schema tip to clarify editor support (VS Code, In… - #6819
Open
fern-api[bot] wants to merge 1 commit into
Open
Expand generators.yml schema tip to clarify editor support (VS Code, In…#6819fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| The `# yaml-language-server: $schema=...` comment 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)) and other editors that embed the YAML Language Server. | ||
|
|
||
| **IntelliJ IDEA** does not use the YAML Language Server comment directive. To get schema validation in IntelliJ, open **Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings**, add a new mapping, set the schema URL to `https://schema.buildwithfern.dev/generators-yml.json`, and map it to your `generators.yml` file. |
Contributor
There was a problem hiding this comment.
📝 [vale] <FernStyles.Acronyms> reported by reviewdog 🐶
'IDEA' has no definition.
|
|
||
| The `# yaml-language-server: $schema=...` comment 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)) and other editors that embed the YAML Language Server. | ||
|
|
||
| **IntelliJ IDEA** does not use the YAML Language Server comment directive. To get schema validation in IntelliJ, open **Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings**, add a new mapping, set the schema URL to `https://schema.buildwithfern.dev/generators-yml.json`, and map it to your `generators.yml` file. |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'doesn't' instead of 'does not'.
Suggested change
| **IntelliJ IDEA** does not use the YAML Language Server comment directive. To get schema validation in IntelliJ, open **Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings**, add a new mapping, set the schema URL to `https://schema.buildwithfern.dev/generators-yml.json`, and map it to your `generators.yml` file. | |
| **IntelliJ IDEA** doesn't use the YAML Language Server comment directive. To get schema validation in IntelliJ, open **Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings**, add a new mapping, set the schema URL to `https://schema.buildwithfern.dev/generators-yml.json`, and map it to your `generators.yml` file. |
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-09-02-fern-ai-2fbdc2-7bdfdbb8.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expanded the
<Tip>block near the top offern/products/sdks/reference/generators-yml-reference.mdxto explain which editors recognize the# yaml-language-server: $schema=...directive (VS Code via the YAML extension and other editors embedding the YAML Language Server) and to provide step-by-step instructions for IntelliJ IDEA users, who must configure schema validation through Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings instead.