Merge branch 'main' of https://github.com/fern-api/docs into niels/update-npm-publishing-with-oidc

Author: Swimburger

.github/workflows/auto-merge-on-docs-release.yml

@@ -0,0 +1,50 @@
+# .github/workflows/auto-merge-on-release.yml in docs repo
+name: Auto-merge on Docs Release
+on:
+  repository_dispatch:
+    types: [docs_release]
+
+jobs:
+  merge-dependent-prs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Find and merge dependent PRs
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const version = context.payload.client_payload.version;
+            
+            // Find PRs with matching labels
+            const { data: prs } = await github.rest.pulls.list({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open'
+            });
+            
+            for (const pr of prs) {
+              const labels = pr.labels.map(l => l.name);
+              const hasLatestLabel = labels.includes('depends-on: docs@latest');
+              const hasVersionLabel = labels.includes(`depends-on: docs@${version}`);
+              
+              if (hasLatestLabel || hasVersionLabel) {
+                // Check if PR is approved and CI passes
+                const { data: reviews } = await github.rest.pulls.listReviews({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  pull_number: pr.number
+                });
+                
+                const approved = reviews.some(r => r.state === 'APPROVED');
+                
+                if (approved) {
+                  await github.rest.pulls.merge({
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    pull_number: pr.number,
+                    merge_method: 'squash'
+                  });
+                  
+                  console.log(`Merged PR #${pr.number}: ${pr.title}`);
+                }
+              }
+            }

.vale.ini

@@ -19,6 +19,9 @@ Microsoft.Accessibility = NO
 Microsoft.Passive = NO
 Microsoft.Suspended = NO
 Microsoft.Vocab = NO
+Microsoft.Semicolon = NO # Mostly just picks up code
+Microsoft.SentenceLength = NO # Mostly just picks up code
+Microsoft.Dashes = NO
 
 # Not relevant for Fern audience
 Microsoft.GeneralURL = NO

.vale/styles/FernStyles/Headings.yml

@@ -39,4 +39,44 @@ exceptions:
   - gRPC
   - RPC
   - SDK
-  - SDKs
+  - SDKs
+  - Accordion
+  - Accordions
+  - Accordion Groups
+  - Aside
+  - Badge
+  - Badges
+  - Button
+  - Callout
+  - Callouts
+  - Card
+  - Cards
+  - Card Groups
+  - Code Blocks
+  - CodeBlock
+  - CodeBlocks
+  - CodeGroup
+  - Embed
+  - Endpoint Request Snippet
+  - Endpoint Response Snippet
+  - Endpoint Schema Snippet
+  - Frame
+  - Frames
+  - Icon
+  - Icons
+  - Param Field
+  - Param Fields
+  - ParamField
+  - Runnable Endpoint
+  - Step
+  - Steps
+  - Sticky Table
+  - StickyTable
+  - Tab
+  - Tabs
+  - Tooltip
+  - Tooltips
+  - PDF
+  - CSS
+  - HTML
+  - JSON

fern/apis/fai/openapi.json

@@ -474,7 +474,7 @@
           }
         },
         "x-fern-audiences": [
-          "internal"
+          "customers"
         ],
         "security": [
           {
@@ -2026,7 +2026,7 @@
           }
         },
         "x-fern-audiences": [
-          "internal"
+          "customers"
         ],
         "security": [
           {

fern/products/cli-api-reference/cli-changelog/2025-10-23.mdx

@@ -1,3 +1,16 @@
+## 0.94.6
+**`(fix):`** Fixed bug in openapi-importer where file type params in multipart/form-data
+were incorrectly marked as required.
+
+
+## 0.94.5
+**`(fix):`** Properly reload pages with Markdown snippets if you update the snippet in `fern docs dev`
+
+
+## 0.94.4
+**`(fix):`** Restore support for x-fern-examples path parameters if there is no request body.
+
+
 ## 0.94.3
 **`(fix):`** Fix broken recursive unescaping of \ during handling of \$ in IR generation.
 

fern/products/docs/pages/component-library/custom-components/conditional-rendering.mdx

@@ -1,5 +1,5 @@
 ---
-title: Conditionally Rendered Content
+title: Conditionally rendered content
 ---
 
 You can conditionally render content based on the instance or version of the docs, in addition to the role of an authenticated user.
@@ -46,4 +46,4 @@ instances:
 <If viewer={["admin"]}>
   This is an admin feature. It should only be available when the user is an admin.
 </If>
-```
+```

fern/products/docs/pages/component-library/custom-components/custom-css-js.mdx

@@ -139,7 +139,7 @@ You can use custom CSS to create brand-specific styling for tables, components,
 
 ## Custom JavaScript
 
-Customize the behavior of your Docs site by injecting custom JavaScript globally. Add a `custom.js` file and include it in your `fern/` project:
+Customize the behavior of your Docs site by injecting custom JavaScript globally.Add a `custom.js` file and include it in your `fern/` project:
 
 <CodeBlock title="Add the custom.js file">
 ```bash {5}
@@ -266,8 +266,8 @@ ReactDOM.render(
 - `ReactDOM.render()` may need to be called multiple times to prevent it from unmounting (this side-effect will be removed in the future).
 - `yarn build` or `npm build` must generate files with deterministic names to be referenced in `docs.yml`. The above example uses a [`vite` config](https://github.com/fern-api/docs-custom-js-example/blob/main/custom-app/vite.config.ts) to accomplish this.
 - For your hosted Docs site, you may need to update your CD steps to include building the react-app.
-- Custom components are not supported in local development. They are supported in preview links.
+- Custom components aren't supported in local development, but are supported in preview links.
 
 <Info>
 This approach is subject to change, with notice, as we make improvements to the plugin architecture.
-</Info> 
+</Info>    

fern/products/docs/pages/component-library/default-components/accordion-groups.mdx

@@ -6,7 +6,7 @@ description: 'Display expandable/collapsible options that reveal more informatio
 Accordion Groups allow you to organize content into collapsible sections, making it easier for users to navigate through information. With recent updates, our Accordion component now supports improved search functionality using the browser's built-in search feature.
 
 <AccordionGroup>
-  <Accordion title="Basic Usage">
+  <Accordion title="Basic usage">
     Accordion Groups can contain multiple Accordion items. Each item has a title and content that can be expanded or collapsed.
 
     ```jsx
@@ -21,7 +21,7 @@ Accordion Groups allow you to organize content into collapsible sections, making
     ```
   </Accordion>
 
-  <Accordion title="Searchable Content">
+  <Accordion title="Searchable content">
     The updated Accordion component now uses HTML5 `<details>` and `<summary>` elements, enabling browser search (Cmd+F / Ctrl+F) to find content within collapsed sections.
   </Accordion>
 
@@ -30,22 +30,22 @@ Accordion Groups allow you to organize content into collapsible sections, making
   </Accordion>
 </AccordionGroup>
 
-### Enhanced Search Functionality
+### Enhanced search functionality
 
 The recent update to our Accordion component improves content discoverability by allowing users to search through all content, including collapsed sections, using the browser's search function (Cmd+F / Ctrl+F).
 
-### Usage Examples
+### Usage examples
 
 Here are some examples of how to use the Accordion Group component:
 
 <Tabs>
 <Tab title="Example">
   <AccordionGroup>
-    <Accordion title="Simple Text Content">
+    <Accordion title="Simple text content">
       This is a basic example with text content.
     </Accordion>
 
-    <Accordion title="With Code Snippets">
+    <Accordion title="With code snippets">
       You can include code snippets within Accordions:
 
       ```javascript
@@ -55,7 +55,7 @@ Here are some examples of how to use the Accordion Group component:
       ```
     </Accordion>
 
-    <Accordion title="Nested Components">
+    <Accordion title="Nested components">
       Accordions can contain other components:
 
       <Frame caption="Sample image">
@@ -65,14 +65,14 @@ Here are some examples of how to use the Accordion Group component:
   </AccordionGroup>
 </Tab>
 <Tab title="Markdown">
-  <CodeBlock title="Example Usage">
+  <CodeBlock title="Example usage">
     ````jsx
     <AccordionGroup>
-      <Accordion title="Text Example">
+      <Accordion title="Text example">
         This is a basic example of an accordion group.
       </Accordion>
 
-      <Accordion title="Multimedia Example">
+      <Accordion title="Multimedia example">
         You can embed photos, videos, and other media within accordions for rich interactive content.
 
         <embed 
@@ -83,7 +83,7 @@ Here are some examples of how to use the Accordion Group component:
         />
       </Accordion>
 
-      <Accordion title="Rich Content Support">
+      <Accordion title="Rich content support">
         Accordions can contain rich content including code blocks, callouts, and other components.
 
         ```ts
@@ -93,7 +93,7 @@ Here are some examples of how to use the Accordion Group component:
         ```
       </Accordion>
 
-      <Accordion title="Best Practices Using Accordion Groups">
+      <Accordion title="Best practices using Accordion Groups">
         - Use accordion groups when you have multiple related sections
         - Each accordion should have a clear title
         - Keep content concise and focused

fern/products/docs/pages/component-library/default-components/cards.mdx

@@ -77,6 +77,56 @@ You can use individual cards or [use the `CardGroup` component](/docs/writing-co
 </Tab>
 </Tabs>
 
+## Adding images to cards
+
+Cards support displaying images alongside content. The image automatically resizes to fit the card dimensions, so you typically don't need to specify `imageWidth` or `imageHeight` unless you want to override the default behavior.
+
+<Tabs>
+<Tab title="Card with image">
+<Card 
+    title="Product Overview" 
+    src="https://images.unsplash.com/photo-1517694712202-14dd9538aa97"
+    imagePosition="left"
+>
+    Display an image alongside your card content. The image automatically scales to fit the card.
+</Card>
+</Tab>
+<Tab title="Markdown">
+```jsx
+<Card 
+    title="Product Overview" 
+    src="https://images.unsplash.com/photo-1517694712202-14dd9538aa97"
+    imagePosition="left"
+>
+    Display an image alongside your card content. The image automatically scales to fit the card.
+</Card>
+```
+</Tab>
+</Tabs>
+
+<Tabs>
+<Tab title="Card with image on top">
+<Card 
+    title="Getting Started" 
+    src="https://images.unsplash.com/photo-1498050108023-c5249f4df085"
+    imagePosition="top"
+>
+    Position the image at the top of the card for a banner-style layout.
+</Card>
+</Tab>
+<Tab title="Markdown">
+```jsx
+<Card 
+    title="Getting Started" 
+    src="https://images.unsplash.com/photo-1498050108023-c5249f4df085"
+    imagePosition="top"
+>
+    Position the image at the top of the card for a banner-style layout.
+</Card>
+```
+</Tab>
+</Tabs>
+
 ## Properties
 
 <ParamField path="title" type="string">
@@ -100,3 +150,15 @@ You can use individual cards or [use the `CardGroup` component](/docs/writing-co
 <ParamField path="lightModeColor" type="string">
   Hex color value for the icon in light mode (e.g. `#FF0F00`)
 </ParamField>
+<ParamField path="src" type="string">
+  URL of the image to display in the card. When set, the card displays the image alongside the content.
+</ParamField>
+<ParamField path="imagePosition" type="'top' | 'left' | 'right' | 'bottom'" default="top">
+  Position of the image relative to the card content. Use `imagePosition` to control the layout.
+</ParamField>
+<ParamField path="imageWidth" type="string">
+  Width of the image (e.g. `200px`, `50%`). Only use if you need to override the default sizing. The image automatically resizes to fit the card by default.
+</ParamField>
+<ParamField path="imageHeight" type="string">
+  Height of the image (e.g. `150px`, `100%`). Only use if you need to override the default sizing. The image automatically resizes to fit the card by default.
+</ParamField>

fern/products/docs/pages/component-library/default-components/code-blocks.mdx

@@ -272,13 +272,13 @@ By default, long lines that exceed the width of the code block become scrollable
 
 <Tabs>
   <Tab title="Example">
-    ```txt title="Without Word Wrap"
+    ```txt title="Without wordWrap"
     A very very very long line of text that may cause the code block to overflow and scroll as a result. 
     ```
   </Tab>
   <Tab title="Markdown">
     ````markdown
-    ```txt title="Without Word Wrap"
+    ```txt title="Without wordWrap"
     A very very very long line of text that may cause the code block to overflow and scroll as a result. 
     ```
     ````
@@ -289,14 +289,14 @@ To disable scrolling and wrap overflow onto the next line, use the `wordWrap` pr
 
 <Tabs>
   <Tab title="Example">
-    ```txt title="With Word Wrap" wordWrap
+    ```txt title="With wordWrap" wordWrap
     A very very very long line of text that may cause the code block to overflow and scroll as a result. 
     ```
   </Tab>
   <Tab title="Markdown">
     ````markdown
-    ```txt title="With Word Wrap" wordWrap
-    A very very very long line of text that may cause the codeblock to overflow and scroll as a result. 
+    ```txt title="With wordWrap" wordWrap
+    A very very very long line of text that may cause the code block to overflow and scroll as a result. 
     ```
     ````
   </Tab>