feat(docs): enable yaml-language-server in generators.yml across Fe…

…rn's Fern Definitions (#5273) add lang server
fern-api · Nov 25, 2024 · c7c0b85 · c7c0b85
1 parent 92826df
commit c7c0b85
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 7 deletions.
diff --git a/fern/apis/docs-yml/generators.yml b/fern/apis/docs-yml/generators.yml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
+
 default-group: local
 groups:
   local:

diff --git a/fern/apis/fern-definition/generators.yml b/fern/apis/fern-definition/generators.yml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
+
 default-group: local
 groups:
   local:

diff --git a/fern/apis/fhir/generators.yml b/fern/apis/fhir/generators.yml
@@ -1,4 +1,5 @@
-# default-group: sdks
+# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
+
 groups:
   sdks:
     generators:

diff --git a/fern/apis/generators-yml/generators.yml b/fern/apis/generators-yml/generators.yml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
+
 default-group: local
 groups:
   local:  

diff --git a/fern/apis/public-api/generators.yml b/fern/apis/public-api/generators.yml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
+
 groups:
   node-sdk:
     audiences:
@@ -40,7 +42,6 @@ groups:
           coordinate: com.fern.api:fern-java-sdk
           username: fernapi
           password: ${MAVEN_PASSWORD}
-          # TODO: uncomment after this config is released
           signature:
             keyId: ${MAVEN_CENTRAL_SECRET_KEY_KEY_ID}
             password: ${MAVEN_CENTRAL_SECRET_KEY_PASSWORD}

diff --git a/fern/pages/sdks/introduction/configuration.mdx b/fern/pages/sdks/introduction/configuration.mdx
@@ -96,10 +96,8 @@ metadata:
 
 ## Schema Validation
 
-Add the following line to the top of your `generators.yml` to enable schema validation:
+Add the following as a comment in your `generators.yml` to enable schema validation, ensuring that your configuration is correct. Check out an example in [Cartesia's Fern Folder](https://github.com/cartesia-ai/docs/blob/43b143f66845d90bffbd0ef1951fd812229d95c0/fern/generators.yml#L1).
 
 ```yaml
-# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
-```
-
-This will enable schema validation in your editor, ensuring that your configuration is correct.
+yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
+```