fern-api · devin-ai-integration · Oct 21, 2025 · Oct 21, 2025 · Oct 21, 2025
diff --git a/.vale/styles/FernStyles/Headings.yml b/.vale/styles/FernStyles/Headings.yml
@@ -27,3 +27,8 @@ exceptions:
   - Support
   - Markdown
   - Docs
+  - GitHub
+  - Actions
+  - CI/CD
+  - CircleCI
+  - GitLab
diff --git a/fern/docs.yml b/fern/docs.yml
@@ -8,7 +8,7 @@ instances:
         repo: docs
         branch: main
 
-title: Fern Documentation
+title: Fern documentation
 
 metadata:
   og:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png
@@ -43,14 +43,14 @@ products:
     slug: ask-fern
     subtitle: Let users find answers in your documentation instantly
 
-  - display-name: CLI Reference
+  - display-name: CLI reference
     subtitle: Manage and configure your Fern projects
     path: ./products/cli-api-reference/cli-api-reference.yml
     icon: fa-regular fa-terminal
     image: ./images/product-switcher/product-switcher-cliapi-light.png
     slug: cli-api-reference
 
-  - display-name: API Definitions
+  - display-name: API definitions
     path: ./products/api-def/api-def.yml
     icon: fa-regular fa-book
     image: ./images/product-switcher/openapi-definition-light.png

diff --git a/fern/products/api-def/api-def.yml b/fern/products/api-def/api-def.yml
@@ -31,7 +31,7 @@ navigation:
           - page: Multipart form uploads
             path: ./openapi-pages/endpoints/multipart.mdx
             slug: multipart
-          - page: Server-sent events
+          - page: Server-Sent Events
             path: ./openapi-pages/endpoints/sse.mdx
             slug: sse
       - section: Extensions
@@ -145,7 +145,7 @@ navigation:
       - section: Methods
         slug: methods
         contents:
-          - page: JSON-RPC methods
+          - page: Json-rpc methods
             path: ./openrpc-pages/methods/rpc-methods.mdx
             slug: rpc-methods
           - page: Notifications
@@ -238,7 +238,7 @@ navigation:
           - page: Bytes
             path: ./ferndef-pages/endpoints/bytes.mdx
             slug: bytes                
-          - page: Server-sent events
+          - page: Server-Sent Events
             path: ./ferndef-pages/endpoints/sse.mdx
             slug: sse
       - section: Advanced
@@ -259,7 +259,7 @@ navigation:
             path: ./ferndef-pages/audiences.mdx
           - page: Availability
             path: ./ferndef-pages/availability.mdx
-      - section: api.yml reference
+      - section: Api.yml reference
         slug: api-yml
         contents:
           - page: Overview

diff --git a/fern/products/api-def/asyncapi-def.yml b/fern/products/api-def/asyncapi-def.yml
@@ -1,5 +1,5 @@
 navigation:
-  - page: AsyncAPI Definition Redirect Page
+  - page: AsyncAPI definition redirect page
     path: ./pages/asyncapi-empty.mdx
     slug: empty-page
     hidden: true
diff --git a/fern/products/api-def/asyncapi-pages/auth.mdx b/fern/products/api-def/asyncapi-pages/auth.mdx
@@ -59,7 +59,7 @@ components:
         env: AUTH_TOKEN
 ```
 
-## API Key security scheme
+## API key security scheme
 
 Start by defining an `apiKey` security scheme in your `asyncapi.yml`: 
 
@@ -81,7 +81,7 @@ const client = new Client({
 })
 ```
 
-### Custom API Key variable name
+### Custom API key variable name
 
 If you want to control variable naming and the environment variable to scan, 
 use the configuration below:
@@ -120,7 +120,7 @@ const client = new Client({
 })
 ```
 
-### Custom Basic Auth variable names
+### Custom basic auth variable names
 
 If you want to control variable naming and the environment variables to scan, 
 use the configuration below:
@@ -139,7 +139,7 @@ components:
         env: PASSWORD
 ```
 
-## OAuth2 security scheme
+## Oauth2 security scheme
 
 <Markdown src="/snippets/pro-plan.mdx"/>
 

diff --git a/fern/products/api-def/asyncapi-pages/automation.mdx b/fern/products/api-def/asyncapi-pages/automation.mdx
@@ -85,7 +85,7 @@ api:
       version: 0.8.8
 ```
 
-### From Git repository
+### From git repository
 ```yaml title="generators.yml" {3-7}
 api:
   specs:
@@ -200,4 +200,4 @@ api:
       version: 0.8.8
 ```
 
-This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation. 
+This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.      
diff --git a/fern/products/api-def/asyncapi-pages/channels/bindings.mdx b/fern/products/api-def/asyncapi-pages/channels/bindings.mdx
@@ -58,7 +58,7 @@ operations:
         method: message
 ```
 
-## MQTT bindings
+## Mqtt bindings
 
 Configure MQTT-specific settings for IoT and messaging applications:
 

diff --git a/fern/products/api-def/asyncapi-pages/overview.mdx b/fern/products/api-def/asyncapi-pages/overview.mdx
@@ -109,7 +109,7 @@ components:
         - message
 ```
 
-## Set up your fern folder
+## Set up your Fern folder
 
 <Info> 
   Considering options to generate an AsyncAPI spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) 

diff --git a/fern/products/api-def/ferndef-def.yml b/fern/products/api-def/ferndef-def.yml
@@ -1,5 +1,5 @@
 navigation:
-  - page: Fern Definition Redirect Page
+  - page: Fern Definition redirect page
     path: ./pages/ferndef-empty.mdx
     slug: empty-page
     hidden: true
diff --git a/fern/products/api-def/ferndef-pages/audiences.mdx b/fern/products/api-def/ferndef-pages/audiences.mdx
@@ -99,7 +99,7 @@ groups:
     ...
 ```
 
-## Audiences with docs 
+## Audiences with docs
 
 If generating Fern Docs, update your `docs.yml` configuration to include your audiences. 
 

diff --git a/fern/products/api-def/ferndef-pages/availability.mdx b/fern/products/api-def/ferndef-pages/availability.mdx
@@ -13,7 +13,7 @@ Availability can be:
 - `deprecated` which means it will be removed in the future; will show a `Deprecated` tag
 - `generally-available` which means it is stable and available for use; will show a `GA` tag
 
-### Endpoint 
+### Endpoint
 
 <CodeBlock title="pet.yml">
 ```yaml {6}
@@ -71,7 +71,7 @@ In Fern Docs, this will look like:
 ![Screenshot showing a beta tag next to a type in API Reference docs](https://fern-image-hosting.s3.amazonaws.com/type-beta.png)
 </Frame>
 
-### Property 
+### Property
 
 <CodeBlock title="pet.yml">
 ```yaml {12}

diff --git a/fern/products/api-def/ferndef-pages/endpoints.mdx b/fern/products/api-def/ferndef-pages/endpoints.mdx
@@ -283,7 +283,7 @@ types:
 ```
 </CodeBlock>
 
-### Response status codes 
+### Response status codes
 
 You can also use the `status-code` field to specify a custom status code 
 for a success response. 

diff --git a/fern/products/api-def/ferndef-pages/endpoints/multipart.mdx b/fern/products/api-def/ferndef-pages/endpoints/multipart.mdx
@@ -24,7 +24,7 @@ service:
 
 Within a given multipart request, a string parameter with `format:binary` will represent an arbitrary file.
 
-## List of Files
+## List of files
 
 If your endpoint supports a list of files, then your request body must indicate such.
 

diff --git a/fern/products/api-def/ferndef-pages/endpoints/sse.mdx b/fern/products/api-def/ferndef-pages/endpoints/sse.mdx
@@ -34,7 +34,7 @@
       text: string
 ```
 
-## Server-sent events 
+## Server-Sent Events
 
 If your API returns server-sent-events, with the `data` and `event` keys as seen below
 
@@ -63,7 +63,7 @@
       text: string        
 ```
 
-## `Stream` parameter
+## `stream` parameter
 
 It has become common practice for endpoints to have a `stream` parameter that 
 controls whether the response is streamed or not. Fern supports this pattern in a first 

diff --git a/fern/products/api-def/ferndef-pages/types.mdx b/fern/products/api-def/ferndef-pages/types.mdx
@@ -138,7 +138,7 @@ types:
         value: '!='
 ```
 
-### Discriminated Unions
+### Discriminated unions
 
 Fern supports tagged unions (a.k.a. discriminated unions). Unions are useful for
 polymorphism. This is similar to the `oneOf` concept in OpenAPI.
@@ -196,7 +196,7 @@ This corresponds to a JSON object like this:
 }
 ```
 
-### Undiscriminated Unions
+### Undiscriminated unions
 
 Undiscriminated unions are similar to discriminated unions, however you don't 
 need to define an explicit discriminant property. 

diff --git a/fern/products/api-def/ferndef-pages/webhooks.mdx b/fern/products/api-def/ferndef-pages/webhooks.mdx
@@ -63,7 +63,7 @@
   ```
 </CodeBlock>
 
-## Generate webhook reference
+## Generate Webhook reference
 
 Fern Docs can automatically generate your webhook reference documentation from your definition. Set this up in your `docs.yml` file. 
 

diff --git a/fern/products/api-def/ferndef-pages/websockets.mdx b/fern/products/api-def/ferndef-pages/websockets.mdx
@@ -24,7 +24,7 @@
     - `body`: The schema of the message
 - `examples`: Example WebSocket connection _(Optional)_
 
-### WebSocket example 
+### WebSocket example
 
 <CodeBlock title='chat.yml'>
   ```yaml
@@ -75,17 +75,17 @@
   ```
 </CodeBlock>
 
-## WebSocket API Reference
+## WebSocket API reference
 
-### WebSocket Reference
+### WebSocket reference
 
 Fern renders a unique reference page for WebSockets. The **Handshake** section outlines the protocol for connecting with the server, while the **Send** and **Receive** sections outline the message schemas that can be sent between the client and server. 
 
 <Frame caption="Cartesia's WebSocket Reference page">
 <img src="./wss-reference.png" alt="The WebSocket Reference" />
 </Frame>
 
-### WebSocket Playground
+### WebSocket playground
 
 <Markdown src="/snippets/pro-plan.mdx" />
 

diff --git a/fern/products/api-def/grpc-def.yml b/fern/products/api-def/grpc-def.yml
@@ -1,5 +1,5 @@
 navigation:
-  - page: gRPC Definition Redirect Page
+  - page: gRPC definition redirect page
     path: ./pages/grpc-empty.mdx
     slug: empty-page
     hidden: true
diff --git a/fern/products/api-def/grpc-pages/auth.mdx b/fern/products/api-def/grpc-pages/auth.mdx
@@ -5,7 +5,7 @@ subtitle: Configure authentication for gRPC services including TLS, JWT, and cus
 
 gRPC supports various authentication mechanisms to secure your services. Authentication can be configured at the transport level (TLS) and at the application level (credentials, tokens, etc.).
 
-## Transport Security (TLS)
+## Transport security (tls)
 
 gRPC strongly recommends using TLS for production services to ensure encrypted communication:
 
@@ -62,7 +62,7 @@ def create_secure_server():
     return server
 ```
 
-## JWT Authentication
+## Jwt authentication
 
 Use JWT tokens for stateless authentication:
 
@@ -116,7 +116,7 @@ class AuthServiceServicer(auth_service_pb2_grpc.AuthServiceServicer):
         )
 ```
 
-## Interceptors for Authentication
+## Interceptors for authentication
 
 Use gRPC interceptors to handle authentication across all methods:
 
@@ -173,7 +173,7 @@ class AuthInterceptor(grpc.ServerInterceptor):
         return grpc.unary_unary_rpc_method_handler(abort)
 ```
 
-## API Key Authentication
+## API key authentication
 
 Implement API key-based authentication:
 
@@ -226,7 +226,7 @@ class ApiKeyAuthInterceptor(grpc.ServerInterceptor):
         return continuation(handler_call_details)
 ```
 
-## OAuth2 Integration
+## Oauth2 integration
 
 Integrate with OAuth2 providers:
 
@@ -270,7 +270,7 @@ class OAuth2Interceptor(grpc.ServerInterceptor):
             return self._invalid_token_response()
 ```
 
-## Client-side Authentication
+## Client-side authentication
 
 Configure authentication on the client side:
 
@@ -309,7 +309,7 @@ def create_api_key_channel(server_address, api_key):
     return intercepted_channel
 ```
 
-## Role-Based Access Control
+## Role-based access control
 
 Implement RBAC for fine-grained permissions:
 

diff --git a/fern/products/api-def/grpc-pages/automation.mdx b/fern/products/api-def/grpc-pages/automation.mdx
@@ -55,7 +55,7 @@ jobs:
           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
 ```
 
-## Protocol Buffer validation
+## Protocol buffer validation
 
 Add validation steps for your Protocol Buffer files:
 
@@ -103,7 +103,7 @@ jobs:
 
 Configure Fern to automatically pull Protocol Buffer files from various sources:
 
-### From Git repository
+### From git repository
 ```yaml title="generators.yml" {3-7}
 api:
   specs:

diff --git a/fern/products/api-def/grpc-pages/overview.mdx b/fern/products/api-def/grpc-pages/overview.mdx
@@ -159,7 +159,7 @@ enum ChatMessageType {
 }
 ```
 
-## Set up your fern folder
+## Set up your Fern folder
 
 <Info> Need help getting started with gRPC and Fern? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,3 +27,8 @@ exceptions: @@
       - Support
       - Markdown
       - Docs
+      - GitHub
+      - Actions
+      - CI/CD
+      - CircleCI
+      - GitLab