🌿 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/actions-comment-pull-request@v2.4.3
+        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.

fern/GHL.mdx

@@ -0,0 +1,151 @@
+---
+title: How to Connect Vapi with Make & GHL
+slug: GHL
+---
+
+
+Vapi's GHL/Make Tools integration allows you to directly import your GHL workflows and Make scenarios into Vapi as Tools. This enables you to create voicebots that can trigger your favorite app integrations and automate complex workflows using voice commands.
+
+## What are GHL/Make Tools?
+
+GHL (GoHighLevel) workflows and Make scenarios are powerful automation tools that allow you to connect and integrate various apps and services. With the GHL/Make Tools integration, you can now bring these automations into Vapi and trigger them using voice commands.
+
+## How does the integration work?
+
+1. **Import workflows and scenarios**: Navigate to the [Tools section](https://dashboard.vapi.ai/tools) in your Vapi dashboard and import your existing GHL workflows and Make scenarios.
+
+2. **Add Tools to your assistants**: Once imported, you can add these Tools to your AI assistants, enabling them to trigger the automations based on voice commands.
+
+3. **Trigger automations with voice**: Your AI assistants can now understand voice commands and execute the corresponding GHL workflows or Make scenarios, allowing for seamless voice-enabled automation.
+
+## Setting up the GHL/Make Tools integration
+
+1. **Create a GHL workflow or Make scenario**: Design your automation in GHL or Make, connecting the necessary apps and services.
+
+2. **Import the workflow/scenario into Vapi**: In the Vapi dashboard, navigate to the Tools section and click on "Import." Select the GHL workflow or Make scenario you want to import.
+
+3. **Configure the Tool**: Provide a name and description for the imported Tool, and map any required input variables to the corresponding Vapi entities (e.g., extracted from user speech).
+
+4. **Add the Tool to your assistant**: Edit your AI assistant and add the newly imported Tool to its capabilities. Specify the voice commands that should trigger the Tool.
+
+5. **Test the integration**: Engage with your AI assistant using the specified voice commands and verify that the corresponding GHL workflow or Make scenario is triggered successfully.
+
+## Use case examples
+
+### Booking appointments with AI callers
+
+- Import a GHL workflow that handles appointment booking
+- Configure the workflow to accept appointment details (date, time, user info) from Vapi
+- Add the Tool to your AI assistant, allowing it to book appointments based on voice commands
+
+### Updating CRMs with voice-gathered data
+
+- Import a Make scenario that updates your CRM with customer information
+- Map the scenario's input variables to entities extracted from user speech
+- Enable your AI assistant to gather customer information via voice and automatically update your CRM
+
+### Real Estate: Automated Property Information Retrieval
+
+- Import a Make scenario that retrieves property information from your MLS (Multiple Listing Service) or real estate database
+- Configure the scenario to accept a property address or MLS ID as input
+- Add the Tool to your AI assistant, allowing potential buyers to request property details using voice commands
+- Your AI assistant can then provide key information about the property, such as price, square footage, number of bedrooms/bathrooms, and amenities
+
+### Healthcare/Telehealth: Appointment Reminders and Prescription Refills
+
+- Import a GHL workflow that sends appointment reminders and handles prescription refill requests
+- Configure the workflow to accept patient information and appointment/prescription details from Vapi
+- Add the Tool to your AI assistant, enabling patients to request appointment reminders or prescription refills using voice commands
+- Your AI assistant can confirm the appointment details, send reminders via SMS or email, and forward prescription refill requests to the appropriate healthcare provider
+
+### Restaurant Ordering: Custom Order Placement and Delivery Tracking
+
+- Import a Make scenario that integrates with your restaurant's online ordering system and delivery tracking platform
+- Configure the scenario to accept customer information, order details, and delivery preferences from Vapi
+- Add the Tool to your AI assistant, allowing customers to place custom orders and track their delivery status using voice commands
+- Your AI assistant can guide customers through the ordering process, suggest menu items based on preferences, and provide real-time updates on the order status and estimated delivery time
+
+## Best practices
+
+- Break down complex automations into smaller, focused workflows or scenarios for better maintainability
+- Use clear and concise naming conventions for your imported Tools and their input variables
+- Thoroughly test the integration to ensure reliable performance and accurate data passing
+- Keep your GHL workflows and Make scenarios up to date to reflect any changes in the connected apps or services
+
+## Troubleshooting
+
+- If a Tool is not triggering as expected, verify that the voice commands are correctly configured and the input variables are properly mapped
+- Check the Vapi logs and the GHL/Make execution logs to identify any errors or issues in the automation flow
+- Ensure that the necessary API credentials and permissions are correctly set up in both Vapi and the integrated apps/services
+
+By leveraging Vapi's GHL/Make Tools integration, you can create powerful voice-enabled automations and streamline your workflows, all without extensive coding. Automate tasks, connect your favorite apps, and unlock the full potential of voice AI with Vapi.
+
+## Get Support
+
+Join our Discord to connect with other developers & connect with our team:
+
+<CardGroup cols={2}>
+  <Card
+    title="Join Our Discord"
+    icon="fa-brands fa-discord"
+    iconType="solid"
+    color="#5A65EA"
+    href="https://discord.gg/pUFNcf2WmH"
+  >
+    Connect with our team & other developers using Vapi.
+  </Card>
+  <Card
+    title="Email Support"
+    icon="mailbox"
+    iconType="solid"
+    color="#7a7f85"
+    href="mailto:support@vapi.ai"
+  >
+    Send our support team an email.
+  </Card>
+</CardGroup>
+
+Here are some video tutorials that will guide you on how to use Vapi with services like Make and GoHighLevel:
+
+<div class="video-grid">
+  <iframe
+    src="https://www.youtube.com/embed/PVP1P2nak4M?si=vGGAMZVI3Fzzik9X"
+    title="YouTube video player"
+    frameborder="0"
+    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+    referrerpolicy="strict-origin-when-cross-origin"
+    allowfullscreen
+  />
+  <iframe
+    src="https://www.youtube.com/embed/3LSXJECXpkc?si=hhWsXZeFYC6wM-cq"
+    title="YouTube video player"
+    frameborder="0"
+    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+    referrerpolicy="strict-origin-when-cross-origin"
+    allowfullscreen
+  />
+  <iframe
+    src="https://www.loom.com/embed/026d1c1a2cc64e479044619842ce8bd1?sid=c5934ff7-2f58-4cf3-952a-140938079ca0"
+    title="GoHighLevel Loom Video"
+    frameborder="0"
+    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+    referrerpolicy="strict-origin-when-cross-origin"
+    allowfullscreen
+  />
+  <iframe
+    src="https://www.loom.com/embed/210579f412bd47de8964683b2f28c3ec?sid=1f289c56-d4bc-4923-85bb-6cbc0fe55361"
+    title="GoHighLevel Bulk call Loom Video"
+    frameborder="0"
+    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+    referrerpolicy="strict-origin-when-cross-origin"
+    allowfullscreen
+  />
+  <iframe
+    src="https://www.youtube.com/embed/KwQmJbIOov4?si=x5ep0ziyIM5ueuvG"
+    title="GoHighLevel Bulk call Loom Video"
+    frameborder="0"
+    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+    referrerpolicy="strict-origin-when-cross-origin"
+    allowfullscreen
+  />
+</div>