Merge branch 'main' into jsklan/update-readme-docs

Author: jsklan

examples/typescript-sdk/generators.yml renamed to examples/sdks/generators.yml

@@ -22,4 +22,17 @@ groups:
           namespaceExport: YourClientName
         github:
           repository: your-company/ts-sdk
-  # generator groups for other SDKs go here
+  # This group configures a Python SDK for PyPi publishing
+  python-sdk:
+    generators:
+      - name: fernapi/fern-python-sdk
+        version: 4.28.0
+        output:
+          location: pypi
+          package-name: devin-new-test-package
+          token: ${PYPI_TOKEN}
+        config:
+          client_class_name: MyClientNameDevin
+        github: 
+          repository: devalog/company-python-test
+  # generator groups for other SDKs go here

examples/sdks/python-publish.yml

@@ -0,0 +1,26 @@
+name: Publish Python SDK
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "The version of the Python SDK that you would like to release"
+        required: true
+        type: string
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install Fern CLI
+        run: npm install -g fern-api
+
+      - name: Release Python SDK
+        env:
+          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          fern generate --group python-sdk --version ${{ inputs.version }} --log-level debug

examples/typescript-sdk/typescript-publish.yml renamed to examples/sdks/typescript-publish.yml

@@ -1,6 +1,6 @@
 api:
   specs:
-    - openapi: ./openapi/openapi.json
+    - openapi: ./openapi.json
 default-group: local
 
 groups:

fern/apis/fai/generators.yml

@@ -1,5 +1,8 @@
+## 0.68.0
+**`(feat):`** Fern cli diff command recognizes availability.
+
 ## 0.66.31
-**`(fix):`** Ignore self-referential types that are optional<nullable<SELF>>
+**`(fix):`** Ignore self-referential types that are `optional<nullable<SELF>>`
 
 ## 0.66.30
 **`(fix):`** Skip OpenAPI 3.1 null type properties instead of failing

fern/products/cli-api-reference/cli-changelog/2025-08-28.mdx

@@ -0,0 +1,6 @@
+## 0.69.1
+**`(fix):`** Example generation ignores headers that don't exist in the channel instead of failing hard.
+
+## 0.69.0
+**`(feat):`** Fern diff command can consider from and to generator versions.
+

fern/products/cli-api-reference/cli-changelog/2025-09-02.mdx

@@ -0,0 +1,5 @@
+## 0.69.2
+**`(fix):`** Add custom license name extraction for Java SDK generation. The CLI now reads the first line 
+from custom LICENSE files and passes it to generators via the _fernLicenseName field in customConfig.
+
+

fern/products/cli-api-reference/cli-changelog/2025-09-03.mdx

@@ -201,6 +201,10 @@ navigation:
      contents:
       - page: Overview
         path: ./pages/enterprise/self-hosted.mdx
+      - page: Set up self-hosted documentation
+        path: ./pages/enterprise/self-hosted-set-up.mdx
+        slug: set-up
+        hidden: true
   - section: Integrations
     collapsed: true
     contents:

fern/products/docs/docs.yml

@@ -215,8 +215,8 @@ logo:
 redirects:
   - source: "/old-path"
     destination: "/new-path"
-  - source: "/old-folder/*"
-    destination: "/new-folder/*"
+  - source: "/old-folder/:path"
+    destination: "/new-folder/:path"
 ```
 
 <ParamField path="source" type="string" required={true}>

fern/products/docs/pages/customization/global-configuration.mdx

@@ -0,0 +1,86 @@
+---
+title: Set up self-hosted documentation
+description: Learn how to set up self-hosted documentation on your own infrastructure.
+---
+
+<Note>Self-hosted documentation is only available for the enterprise plan.</Note>
+
+## Prerequisites
+
+Before setting up self-hosted documentation, ensure you have:
+- Docker installed on your system
+- Access to your Fern project's `fern/` directory
+- A Docker Hub account (for accessing the private image)
+
+<Steps>
+<Step title="Request Access to the Docker Image">
+
+The self-hosted documentation runs on a private Docker image: `fernapi/fern-self-hosted`
+
+**Contact Fern Support** and provide your Docker Hub username to the Fern team. Fern will allowlist your account to download the private image
+
+</Step>
+<Step title="Download the Docker Image">    
+
+Once your account is allowlisted, download the latest image:
+
+```bash
+docker pull fernapi/fern-self-hosted:<latest-tag>
+```
+
+<Warning>
+Do not use `fernapi/fern-self-hosted:latest` as it may not contain the most recent version. Always use the specific latest tag provided by Fern.
+</Warning>
+
+You can verify the image is available in your Docker daemon:
+
+```bash
+docker images | grep fernapi/fern-self-hosted
+```
+
+</Step>
+<Step title="Create a Dockerfile">
+
+In the directory containing your `fern/` folder, create a new `Dockerfile` with the following content:
+
+```dockerfile <your-docker-file-name>
+FROM fernapi/fern-self-hosted:<latest-tag>
+
+COPY fern/ /fern/
+```
+
+Replace `<latest-tag>` with the actual tag used in the previous step.
+
+</Step>
+<Step title="Build Your Custom Docker Image">
+
+Build your custom Docker image using the Dockerfile:
+
+```bash
+docker build -f <your-docker-file-name> -t <your-image-name> .
+```
+
+</Step>
+<Step title="Run the Documentation">
+
+Start your self-hosted documentation:
+
+```bash
+docker run -it <your-image-name>
+```
+
+The documentation will be available at the domain specified in your `docs.yml` configuration.
+
+</Step>
+<Step title="Configure Custom Domain">
+
+Your documentation will be published to the domain specified in your `docs.yml` file. For example:
+
+```yaml
+instances:
+  - url: example-org.docs.buildwithfern.com
+    custom-domain: plantstore.dev
+```
+</Step>
+</Steps>  
+