Merge branch 'main' into devalog/net-compatibility

devalog · web-flow · commit 6ae1e51fcb98 · 2025-10-23T13:01:55.000-04:00
diff --git a/.vale/styles/FernStyles/Acronyms.yml b/.vale/styles/FernStyles/Acronyms.yml
@@ -70,3 +70,4 @@ exceptions:
   - AWS # Fern-specific
   - TLS # Fern-specific
   - BCL # Fern-specific
+  - LLM # Fern-specific
diff --git a/.vale/styles/FernStyles/Headings.yml b/.vale/styles/FernStyles/Headings.yml
@@ -31,3 +31,9 @@ exceptions:
   - Unity
   - SDK
   - SDKs
+  - API Reference
+  - API Explorer
+  - GitHub
+  - README
+  - Action
+  - Actions
diff --git a/.vale/styles/FernStyles/Reject.yml b/.vale/styles/FernStyles/Reject.yml
@@ -1,8 +1,11 @@
 extends: substitution
 message: "Use '%s' instead of '%s'."
 level: error
-ignorecase: true
+ignorecase: false
 swap:
   whitelist: allowlist
   blacklist: denylist
-  Visual Editor: Fern Editor
+  Visual Editor: Fern Editor
+  API reference: API Reference
+  Api reference: API Reference
+  API explorer: API Explorer
diff --git a/fern/products/ask-fern/pages/configuration/custom-prompting.mdx b/fern/products/ask-fern/pages/configuration/custom-prompting.mdx
@@ -1,16 +1,16 @@
 ---
-title: Custom Prompting
+title: Custom prompting
 subtitle: Learn how to add your own prompts to our AI Search feature.
 ---
 
 Out of the box, our AI Search feature uses default prompts to help fine-tune search results. You can reference these in our [system prompts](https://github.com/fern-api/fern-platform/blob/app/packages/fern-docs/search-server/ask-fern/src/utils/system-prompt.ts) file.  
 
 Customizing the system prompt gives you the ability to tailor the AI search responses to best serve your users. You can replace the default prompt with your own prompt to increase the relevance and accuracy of the results.
 
-## Customizing Prompts
+## Customizing prompts
 
 <Steps>
-  <Step title="Getting Started">
+  <Step title="Getting started">
       Run `fern upgrade` to ensure you have the latest version of Fern installed.
   </Step>
   <Step title="Configure docs.yml">
diff --git a/fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx b/fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx
@@ -1,5 +1,5 @@
 ---
-title: Locations and Datasources
+title: Locations and datasources
 subtitle: Configure where Ask Fern is available and what content it can access.
 ---
 
@@ -17,7 +17,7 @@ ai-search:
     - discord
 ```
 
-### Available Locations
+### Available locations
 
 <ParamField path="docs" type="string">
   Enables Ask Fern on your documentation site. Users will see the AI search interface directly in your docs.
@@ -44,7 +44,7 @@ ai-search:
       title: Company Blog
 ```
 
-### Website Datasources
+### Website datasources
 
 <ParamField path="url" type="string" required>
   The URL of the website to index. Ask Fern will crawl and index the content from this URL.
@@ -54,15 +54,15 @@ ai-search:
   An optional display name for this datasource. This helps users understand where the information is coming from when Ask Fern cites content from this source.
 </ParamField>
 
-## Preview Environments
+## Preview environments
 
 Setting `location: [docs]` enables Ask Fern on preview deployments generated with `fern generate --docs --preview`, allowing you to test the AI search functionality before publishing to production.
 
 <Note>
   Preview environments don't interfere with your production Ask Fern deployment.
 </Note>
 
-## Best Practices
+## Best practices
 
 <AccordionGroup>
   <Accordion title="Start with docs location">
diff --git a/fern/products/cli-api-reference/cli-api-reference.yml b/fern/products/cli-api-reference/cli-api-reference.yml
@@ -1,5 +1,5 @@
 navigation:
-  - section: CLI Reference
+  - section: CLI reference
     contents:
       - page: Get started with Fern CLI
         path: ./pages/cli-get-started.mdx
diff --git a/fern/products/cli-api-reference/cli-changelog/2025-10-22.mdx b/fern/products/cli-api-reference/cli-changelog/2025-10-22.mdx
@@ -0,0 +1,12 @@
+## 0.94.1
+**`(fix):`** Undo change to skip bundling APIs with docs creation request.
+
+
+## 0.94.0
+**`(feat):`** Handle npm OIDC token publishing for local workspace generation.
+
+
+## 0.93.4
+**`(fix):`** Skip bundling APIs with docs creation request.
+
+
diff --git a/fern/products/cli-api-reference/cli-changelog/2025-10-23.mdx b/fern/products/cli-api-reference/cli-changelog/2025-10-23.mdx
@@ -0,0 +1,6 @@
+## 0.94.2
+**`(fix):`** Improve IR hashing in IntermediateRepresentationChangeDetector.
+Previously it looked at the entire IR. Now it only compares the
+parts of the IR that describe the API interface.
+
+
diff --git a/fern/products/cli-api-reference/pages/cli-get-started.mdx b/fern/products/cli-api-reference/pages/cli-get-started.mdx
@@ -4,7 +4,7 @@ subtitle: Manage and configure your Fern projects, all from the command line.
 description: 'Overview of the Fern CLI including usage, installation, and CI/CD environments'
 ---
 
-## Installing Fern CLI
+## Install Fern CLI
 
 Run the following command to download and install Fern CLI from the [npm](https://www.npmjs.com/) registry. 
 
@@ -13,7 +13,7 @@ npm install -g fern-api # install Fern CLI
 fern -v # ensure Fern was successfully installed
 ```
 
-<Accordion title="Installing Fern CLI locally" toc={true}>
+<Accordion title="Install Fern CLI locally" toc={true}>
 
 If you're experiencing network delays with the global installation, working in an environment with limited internet connectivity, or prefer to manage Fern as a project dependency, you can install the CLI locally:
 
diff --git a/fern/products/cli-api-reference/pages/commands.mdx b/fern/products/cli-api-reference/pages/commands.mdx
@@ -15,14 +15,14 @@ hideOnThisPage: true
 | [`fern export`](#fern-export) | Export an OpenAPI spec for your API |
 | [`fern api update`](#fern-api-update) | Manually update your OpenAPI spec |
 
-## Documentation Commands
+## Documentation commands
 
 | Command | Description |
 |---------|-------------|
 | [`fern docs dev`](#fern-docs-dev) | Run local documentation preview server |
 | [`fern generate --docs`](#fern-generate---docs) | Build & publish documentation updates |
 
-## SDK Generation Commands  
+## SDK generation commands  
 
 | Command | Description |
 |---------|-------------|
@@ -31,7 +31,7 @@ hideOnThisPage: true
 | [`fern write-overrides`](#fern-write-overrides) | Create OpenAPI customizations |
 | [`fern generator upgrade`](#fern-generator-upgrade) | Update SDK generators to latest versions |
 
-## Detailed Command Documentation
+## Detailed command documentation
 
 <AccordionGroup>
   <Accordion title="fern init">
diff --git a/fern/products/cli-api-reference/pages/global-options.mdx b/fern/products/cli-api-reference/pages/global-options.mdx
@@ -4,7 +4,7 @@ description: 'Global options for the Fern CLI'
 subtitle: 'Explore Fern CLI global options.'
 ---
 
-## Quick Reference
+## Quick reference
 
 | Option | Description | Example |
 |--------|-------------|---------|
@@ -98,4 +98,4 @@ fern generate --api payments-api --group python-sdk --version 1.2.3
 
 # Generate TypeScript SDK for the auth API with version 0.1.0
 fern generate --api auth --group ts-sdk --version 0.1.0
-```
+```
diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml
@@ -194,6 +194,7 @@ navigation:
         path: ./pages/seo/redirects.mdx
       - page: llms.txt
         path: ./pages/seo/llms-txt.mdx
+        slug: llms-txt
   - section: Authentication
     collapsed: true
     contents:
@@ -219,28 +220,30 @@ navigation:
         path: ./pages/enterprise/self-hosted-set-up.mdx
         slug: set-up
         hidden: true
-  - section: Integrations
+  - section: Analytics & integrations
+    slug: integrations
     collapsed: true
     contents:
       - page: Overview
         path: ./pages/integrations/overview.mdx
-      - section: Analytics
-        contents:
-          - page: Google
-            path: ./pages/integrations/analytics/google.mdx
-          - page: PostHog
-            path: ./pages/integrations/analytics/posthog.mdx
-            slug: posthog
-          - page: Fullstory
-            path: ./pages/integrations/analytics/fullstory.mdx
-          - page: Segment
-            path: ./pages/integrations/analytics/segment.mdx
-          - page: Mixpanel
-            path: ./pages/integrations/analytics/mixpanel.mdx
-      - section: Support
-        contents:
-          - page: Intercom
-            path: ./pages/integrations/support/intercom.mdx
+      - page: Intercom
+        path: ./pages/integrations/support/intercom.mdx
+        slug: support/intercom
+      - page: Google
+        path: ./pages/integrations/analytics/google.mdx
+        slug: analytics/google
+      - page: PostHog
+        path: ./pages/integrations/analytics/posthog.mdx
+        slug: analytics/posthog
+      - page: Fullstory
+        path: ./pages/integrations/analytics/fullstory.mdx
+        slug: analytics/fullstory
+      - page: Segment
+        path: ./pages/integrations/analytics/segment.mdx
+        slug: analytics/segment
+      - page: Mixpanel
+        path: ./pages/integrations/analytics/mixpanel.mdx
+        slug: analytics/mixpanel
       - page: Postman
         path: ./pages/integrations/postman.mdx
       - page: LaunchDarkly feature flags 
diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx
@@ -1,5 +1,5 @@
 ---
-title: "Integrations"
+title: "Analytics and integrations"
 description: "Integrate with third party platforms for analytics, support, etc."
 ---
 
@@ -69,7 +69,7 @@ analytics:
 
 ### Environment Variables
 
-If your docs configuration is public, then we do not advise adding secret values directly to `docs.yml`.
+If your docs configuration is public, then we don't advise adding secret values directly to `docs.yml`.
 Instead, you can reference an environment variable by using the syntax `${VARIABLE_NAME}`.
 
 <Note>
@@ -91,7 +91,7 @@ are available during the workflow run.
 ## Postman
 
 <Info>
-  The Postman integration is not configured in `docs.yml`. Check out this [page](/learn/docs/integrations/postman) to
+  The Postman integration isn't configured in `docs.yml`. Check out this [page](/learn/docs/integrations/postman) to
   learn more.
 </Info>
 
diff --git a/fern/products/docs/pages/seo/llms-txt.mdx b/fern/products/docs/pages/seo/llms-txt.mdx
@@ -1,39 +1,40 @@
 ---
-title: llms.txt
-subtitle: Enable tools like Cursor, GitHub Copilot, ChatGPT, and Claude to quickly understand your documentation.
-description: Learn how your documentation becomes accessible to AI tools using the llms.txt standard. Make your docs AI-friendly.
-layout: guide
+title: llms.txt and llms-full.txt
+description: Enable tools like Cursor, GitHub Copilot, ChatGPT, and Claude to understand your documentation.
 ---
 
-## What is llms.txt?
-[LLMs.txt](https://llmstxt.org/) is an emerging standard so that websites can easily expose information to AI developer tools.
-LLMs thrive on concise, structured information, and `llms.txt` help them locate and interpret key information in your developer documentation with ease.
-No configuration required--your `llms.txt` files are automatically generated and maintained, just like a `sitemap.xml` or `robots.txt`.
-
-### llms.txt
-- **Small and fast**: Quick to load and easy to parse.
-- **Summary-focused**: Each page distilled into a one-sentence description with its URL.
-- **Structured for AI**: Helps tools understand the overall structure of your documentation.
-
-See an example: [docs.cohere.com/llms.txt](https://docs.cohere.com/llms.txt)
-
-### llms-full.txt
-- **Comprehensive**: Includes the full content of your documentation.
-- **API-Ready**: Automatically incorporates your full API reference and SDK snippets (if generated by Fern).
-- **Token efficient**: Removes unnecessary formatting to be as token-efficient as possible.
-
-See an example: [docs.cohere.com/llms-full.txt](https://docs.cohere.com/llms-full.txt)
-
-## View in Action
-
-Check out the llms.txt files for this site:
-- `https://buildwithfern.com/learn/llms.txt`
-- `https://buildwithfern.com/learn/llms-full.txt`
+[llms.txt](https://llmstxt.org/) is a standard for exposing website content to AI developer tools. Fern automatically generates and maintains `llms.txt` and `llms-full.txt` files for your documentation site. When Fern detects an LLM bot accessing your documentation, it automatically serves Markdown instead of HTML, reducing token consumption by 90%+.
 
 <Frame>
   <img
     src="./llms-txt.png"
     alt="Example of using llms.txt"
     className="rounded-lg border border-gray-200 dark:border-gray-700"
   />
-</Frame>
+</Frame>
+
+## `llms.txt`
+
+Contains a lightweight summary of your documentation site with each page distilled into a one-sentence description and URL. The format is structured to help AI tools parse and understand your documentation's hierarchy and organization.
+
+`llms.txt` is available at any level of your documentation hierarchy (`/llms.txt`, `/docs/llms.txt`, `/v1/api-reference/llms.txt`, etc.).
+
+Examples from Eleven Labs: 
+- Developer documentation (Prompting directory): [elevenlabs.io/docs/best-practices/prompting/llms.txt](https://elevenlabs.io/docs/best-practices/prompting/llms.txt)
+- API Reference (Create speech endpoint): [elevenlabs.io/docs/api-reference/text-to-speech/convert/llms.txt](https://elevenlabs.io/docs/api-reference/text-to-speech/convert/llms.txt)
+
+## `llms-full.txt`
+
+Contains complete documentation content including the full text of all pages. For API documentation, this includes your complete API Reference with resolved OpenAPI specifications and SDK code examples for enabled languages. Each API endpoint page includes its full OpenAPI spec.
+
+`llms-full.txt` is available only at the root of your documentation site.
+
+Example from Cash App: [developers.cash.app/llms-full.txt](https://developers.cash.app/llms-full.txt)
+
+## Analytics and monitoring
+
+The [Fern Dashboard](https://dashboard.buildwithfern.com/) provides comprehensive analytics for `llms.txt` usage including:
+- Traffic by LLM provider (Claude, ChatGPT, Cursor, etc.)
+- Page-level breakdowns of bot vs. human visitors for Markdown and `llms.txt` files
+
+This visibility helps you understand LLM traffic patterns and optimize your documentation for AI consumption.
diff --git a/fern/products/sdks/overview/typescript/changelog/2025-10-21.mdx b/fern/products/sdks/overview/typescript/changelog/2025-10-21.mdx
@@ -1,3 +1,35 @@
+## 3.12.0
+**`(feat):`** Add support for [publishing to npmjs.org using OIDC from GitHub Actions](https://docs.npmjs.com/trusted-publishers).
+
+To use OIDC for publishing to npmjs.org, you need to follow two steps:
+1. Follow the instructions in ["Step 1: Add a trusted publisher on npmjs.com"](https://docs.npmjs.com/trusted-publishers#step-1-add-a-trusted-publisher-on-npmjscom).
+2. Set the `output.token` field to `OIDC` in _generators.yml_ to enable this feature:
+
+    ```yml
+    # In generators.yml
+    groups:
+      ts-sdk:
+        generators:
+          - name: fernapi/fern-typescript-sdk
+            output:
+              location: npm
+              package-name: your-package-name
+              token: OIDC # previously this would be set to something like ${NPM_TOKEN}
+            ...
+    ```
+
+    This will take care of ["Step 2: Configure your CI/CD workflow"](https://docs.npmjs.com/trusted-publishers#step-2-configure-your-cicd-workflow).
+
+For local generation, you'll need Fern CLI version 0.94.0 or later.
+
+
+**`(feat):`** Update GitHub Actions `setup-node` action to v4 in the generated CI workflow.
+
+
+## 3.11.1
+**`(fix):`** Generate streaming response section in README.md for streaming response endpoints.
+
+
 ## 3.11.0
 **`(feat):`** Add `linter` and `formatter` configuration options to configure code linters and formatters for the generated SDK.
 - `linter`:
diff --git a/fern/snippets/version-number-cli.mdx b/fern/snippets/version-number-cli.mdx
@@ -1 +1 @@
-0.93.3
+0.94.2
diff --git a/fern/snippets/version-number-ts.mdx b/fern/snippets/version-number-ts.mdx
@@ -1 +1 @@
-3.11.0
+3.12.0
