🌿 Your Fern Generated Docs (#4)

Author: fern-support

.github/workflows/preview-docs.yml

@@ -0,0 +1,30 @@
+name: Preview Docs
+
+on: pull_request
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Fern
+        run: npm install -g fern-api
+
+      - name: Generate preview URL
+        id: generate-docs
+        env:
+          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+        run: |
+          OUTPUT=$(fern generate --docs --preview --log-level debug 2>&1) || true
+          echo "$OUTPUT"
+          URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()')
+          echo "Preview URL: $URL"
+          echo "🌿 Preview your docs: $URL" > preview_url.txt
+
+      - name: Comment URL in PR
+        uses: thollander/[email protected]
+        with:
+          filePath: preview_url.txt

.github/workflows/preview-sdks.yml

@@ -24,13 +24,13 @@ jobs:
         env:
           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
         run: |
-          fern generate --api v5 --group ts-sdk --preview --log-level debug
+          fern generate --api api  --group ts-sdk --preview --log-level debug
 
       - name: Compile
         env:
           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
         run: |
-          cd fern/apis/v5/.preview/fern-typescript-node-sdk
+          cd fern/apis/api/.preview/fern-typescript-node-sdk
           yarn install
           yarn build
             
@@ -51,7 +51,7 @@ jobs:
         env:
           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
         run: |
-          fern generate --api v5 --group python-sdk --preview --log-level debug
+          fern generate --api api  --group python-sdk --preview --log-level debug
     
       - name: Set up python
         uses: actions/setup-python@v4
@@ -64,6 +64,6 @@ jobs:
 
       - name: Compile
         run: | 
-          cd fern/apis/v5/.preview/fern-python-sdk
+          cd fern/apis/api/.preview/fern-python-sdk
           poetry install          
           poetry run mypy .

.github/workflows/publish-docs.yml

@@ -0,0 +1,22 @@
+name: Publish Docs
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/heads/main') && github.run_number > 1 }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Fern
+        run: npm install -g fern-api
+
+      - name: Publish Docs
+        env:
+          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+        run: fern generate --docs

.github/workflows/release-csharp-sdk.yml

@@ -42,7 +42,7 @@ jobs:
           NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
         run: |
           if [ "${{ github.event.inputs.makePR }}" = "true" ]; then
-            fern generate --group csharp-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
+            fern generate --api api --group csharp-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
           else
-            fern generate --group csharp-sdk --version ${{ inputs.version }} --log-level debug
+            fern generate --api api --group csharp-sdk --version ${{ inputs.version }} --log-level debug
           fi

.github/workflows/release-go-sdk.yml

@@ -41,7 +41,7 @@ jobs:
           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
         run: |
           if [ "${{ github.event.inputs.makePR }}" = "true" ]; then
-            fern generate --group go-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
+            fern generate --api api --group go-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
           else
-            fern generate --group go-sdk --version ${{ inputs.version }} --log-level debug
+            fern generate --api api --group go-sdk --version ${{ inputs.version }} --log-level debug
           fi

.github/workflows/release-java-sdk.yml

@@ -43,7 +43,7 @@ jobs:
           MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
         run: |
           if [ "${{ github.event.inputs.makePR }}" = "true" ]; then
-            fern generate --group java-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
+            fern generate --api api --group java-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
           else
-            fern generate --group java-sdk --version ${{ inputs.version }} --log-level debug
+            fern generate --api api --group java-sdk --version ${{ inputs.version }} --log-level debug
           fi

.github/workflows/release-python-sdk.yml

@@ -42,7 +42,7 @@ jobs:
           PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
         run: |
           if [ "${{ github.event.inputs.makePR }}" = "true" ]; then
-            fern generate --group python-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
+            fern generate --api api --group python-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
           else
-            fern generate --group python-sdk --version ${{ inputs.version }} --log-level debug
+            fern generate --api api --group python-sdk --version ${{ inputs.version }} --log-level debug
           fi

.github/workflows/release-ruby-sdk.yml

@@ -42,7 +42,7 @@ jobs:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
         run: |
           if [ "${{ github.event.inputs.makePR }}" = "true" ]; then
-            fern generate --group ruby-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
+            fern generate --api api --group ruby-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
           else
-            fern generate --group ruby-sdk --version ${{ inputs.version }} --log-level debug
+            fern generate --api api --group ruby-sdk --version ${{ inputs.version }} --log-level debug
           fi

.github/workflows/release-ts-sdk.yml

@@ -42,7 +42,7 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: |
           if [ "${{ github.event.inputs.makePR }}" = "true" ]; then
-            fern generate --group ts-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
+            fern generate --api api --group ts-sdk --version ${{ inputs.version }} --mode pull-request --log-level debug
           else
-            fern generate --group ts-sdk --version ${{ inputs.version }} --log-level debug
+            fern generate --api api --group ts-sdk --version ${{ inputs.version }} --log-level debug
           fi

README.md

@@ -28,19 +28,43 @@ To deploy your SDKs, simply run the `Release Python SDK` GitHub Action with the
 desired version for the release. Under the hood, this leverages the Fern CLI:
 
 ```sh
-fern generate --group python-sdk
+fern generate --api api --group python-sdk
 ```
 
 ### Developing SDKs
 
 You can also regenerate the SDKs locally by running:
 
 ```sh
-fern generate --group python-sdk --preview --log-level debug
+fern generate --api api --group python-sdk --preview --log-level debug
 ```
 
 This will generate the SDK and download it to a local folder that can be pip installed.
 
 ```sh
 pip install -e /fern/.preview/fern-python-sdk
 ```
+
+## How to update documentation?
+
+### Local Development server
+
+To run a local development server with hot-reloading you can run the following command
+
+```sh
+fern docs dev
+```
+
+#### Hosted URL
+
+To update your documentation on a hosted URL, run
+```
+# npm install -g fern-api
+fern generate --docs
+```
+To preview your documentation, run
+```
+# npm install -g fern-api
+fern generate --docs --preview
+```
+The repository contains GitHub workflows that will automatically run these commands for you. For example, when you make a PR a preview link will be auto-generated and when you merge to main the docs site will update.