📝 Migrate from Docusaurus to Mintlify (#1115)

Closes #868

README.md

@@ -72,7 +72,7 @@ Collect your **Results** and get insights:
 Built for **developers**:
 
 - 🔓 No vendor-locking. Features built with flexibility in mind.
-- 💻 Easy-to-use [APIs](https://docs.typebot.io/api).
+- 💻 Easy-to-use [APIs](https://docs.typebot.io/api-reference).
 
 ## Getting started with Typebot
 

apps/builder/package.json

@@ -25,6 +25,7 @@
     "@giphy/js-util": "5.0.0",
     "@giphy/react-components": "7.1.0",
     "@googleapis/drive": "8.0.0",
+    "@lilyrose2798/trpc-openapi": "^1.3.9",
     "@paralleldrive/cuid2": "2.2.1",
     "@sentry/nextjs": "7.77.0",
     "@tanstack/react-query": "4.29.19",
@@ -90,7 +91,6 @@
     "svg-round-corners": "0.4.1",
     "swr": "2.2.0",
     "tinycolor2": "1.6.0",
-    "trpc-openapi": "1.2.0",
     "unsplash-js": "7.0.18",
     "use-debounce": "9.0.4"
   },
@@ -102,9 +102,9 @@
     "@typebot.io/forge-schemas": "workspace:*",
     "@typebot.io/lib": "workspace:*",
     "@typebot.io/prisma": "workspace:*",
+    "@typebot.io/radar": "workspace:*",
     "@typebot.io/schemas": "workspace:*",
     "@typebot.io/tsconfig": "workspace:*",
-    "@typebot.io/radar": "workspace:*",
     "@types/canvas-confetti": "1.6.0",
     "@types/jsonwebtoken": "9.0.2",
     "@types/micro-cors": "0.1.3",

apps/builder/src/features/billing/api/getSubscription.ts

@@ -24,7 +24,7 @@ export const getSubscription = authenticatedProcedure
   )
   .output(
     z.object({
-      subscription: subscriptionSchema.or(z.null()),
+      subscription: subscriptionSchema.or(z.null().openapi({ type: 'string' })),
     })
   )
   .query(async ({ input: { workspaceId }, ctx: { user } }) => {

apps/builder/src/features/billing/api/getUsage.ts

@@ -18,7 +18,11 @@ export const getUsage = authenticatedProcedure
   })
   .input(
     z.object({
-      workspaceId: z.string(),
+      workspaceId: z
+        .string()
+        .describe(
+          '[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)'
+        ),
     })
   )
   .output(z.object({ totalChatsUsed: z.number(), resetsAt: z.date() }))

apps/builder/src/features/billing/api/listInvoices.ts

@@ -20,7 +20,11 @@ export const listInvoices = authenticatedProcedure
   })
   .input(
     z.object({
-      workspaceId: z.string(),
+      workspaceId: z
+        .string()
+        .describe(
+          '[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)'
+        ),
     })
   )
   .output(

apps/builder/src/features/billing/components/ChangePlanForm.tsx

@@ -3,7 +3,6 @@ import { Plan } from '@typebot.io/prisma'
 import { TextLink } from '@/components/TextLink'
 import { useToast } from '@/hooks/useToast'
 import { trpc } from '@/lib/trpc'
-import { Workspace } from '@typebot.io/schemas'
 import { PreCheckoutModal, PreCheckoutModalProps } from './PreCheckoutModal'
 import { useState } from 'react'
 import { ParentModalProvider } from '@/features/graph/providers/ParentModalProvider'
@@ -13,9 +12,10 @@ import { ProPlanPricingCard } from './ProPlanPricingCard'
 import { useTranslate } from '@tolgee/react'
 import { StripeClimateLogo } from './StripeClimateLogo'
 import { guessIfUserIsEuropean } from '@typebot.io/lib/billing/guessIfUserIsEuropean'
+import { WorkspaceInApp } from '@/features/workspace/WorkspaceProvider'
 
 type Props = {
-  workspace: Workspace
+  workspace: WorkspaceInApp
   excludedPlans?: ('STARTER' | 'PRO')[]
 }
 

apps/builder/src/features/billing/components/UsageProgressBars.tsx

@@ -9,15 +9,14 @@ import {
   Tooltip,
 } from '@chakra-ui/react'
 import { AlertIcon } from '@/components/icons'
-import { Workspace } from '@typebot.io/prisma'
-import React from 'react'
+import { WorkspaceInApp } from '@/features/workspace/WorkspaceProvider'
 import { parseNumberWithCommas } from '@typebot.io/lib'
 import { defaultQueryOptions, trpc } from '@/lib/trpc'
 import { getChatsLimit } from '@typebot.io/lib/billing/getChatsLimit'
 import { useTranslate } from '@tolgee/react'
 
 type Props = {
-  workspace: Workspace
+  workspace: WorkspaceInApp
 }
 
 export const UsageProgressBars = ({ workspace }: Props) => {

apps/builder/src/features/graph/helpers/getHelpDocUrl.ts

@@ -44,7 +44,7 @@ export const getHelpDocUrl = (
     case IntegrationBlockType.CHATWOOT:
       return 'https://docs.typebot.io/editor/blocks/integrations/chatwoot'
     case IntegrationBlockType.GOOGLE_ANALYTICS:
-      return 'https://docs.typebot.io/editor/blocks/integrations/ga'
+      return 'https://docs.typebot.io/editor/blocks/integrations/google-analytics'
     case IntegrationBlockType.GOOGLE_SHEETS:
       return 'https://docs.typebot.io/editor/blocks/integrations/google-sheets'
     case IntegrationBlockType.ZAPIER:

apps/builder/src/features/preview/components/ApiPreviewInstructions.tsx

@@ -37,7 +37,7 @@ export const ApiPreviewInstructions = (props: StackProps) => {
       <OrderedList spacing={6} px="1">
         <ListItem>
           All your requests need to be authenticated with an API token.{' '}
-          <TextLink href="https://docs.typebot.io/api/builder/authenticate">
+          <TextLink href="https://docs.typebot.io/api-reference/authentication">
             See instructions
           </TextLink>
           .
@@ -90,7 +90,7 @@ export const ApiPreviewInstructions = (props: StackProps) => {
       <Text fontSize="sm" pl="1">
         Check out the{' '}
         <TextLink
-          href="https://docs.typebot.io/api/start-preview-chat"
+          href="https://docs.typebot.io/api-reference/chat/start-preview-chat"
           isExternal
         >
           API reference

apps/builder/src/features/preview/components/WhatsAppPreviewInstructions.tsx

@@ -79,7 +79,7 @@ export const WhatsAppPreviewInstructions = (props: StackProps) => {
         <Text fontSize="sm">Need help?</Text>
         <Button
           as={Link}
-          href="https://docs.typebot.io/embed/whatsapp"
+          href="https://docs.typebot.io/deploy/whatsapp/overview"
           leftIcon={<BuoyIcon />}
           size="sm"
         >

apps/builder/src/features/publish/components/PublishButton.tsx

@@ -154,7 +154,7 @@ export const PublishButton = ({
             <Stack spacing="3">
               <Text>
                 You are about to a deploy a version of your bot with an updated
-                engine. (Typebot V6).
+                engine (Typebot V6).
               </Text>
               <Text fontWeight="bold">
                 Make sure to check out all the{' '}

apps/builder/src/features/publish/components/embeds/modals/ApiModal.tsx

@@ -86,7 +86,10 @@ export const ApiModal = ({
           </OrderedList>
           <Text fontSize="sm" colorScheme="gray">
             Check out the{' '}
-            <TextLink href="https://docs.typebot.io/api/start-chat" isExternal>
+            <TextLink
+              href="https://docs.typebot.io/api-reference/chat/start-chat"
+              isExternal
+            >
               API reference
             </TextLink>{' '}
             for more information

apps/builder/src/features/publish/components/embeds/modals/WebflowModal/instructions/WebflowPopupInstructions.tsx

@@ -30,7 +30,10 @@ export const WebflowPopupInstructions = () => {
       </OrderedList>
       <Text fontSize="sm" colorScheme="gray" pl="5">
         Check out the{' '}
-        <TextLink href="https://docs.typebot.io/embed/webflow#popup" isExternal>
+        <TextLink
+          href="https://docs.typebot.io/deploy/web/webflow#popup"
+          isExternal
+        >
           Webflow embed documentation
         </TextLink>{' '}
         for more options.

apps/builder/src/features/publish/components/embeds/modals/WhatsAppModal/WhatsAppCredentialsModal.tsx

@@ -302,7 +302,7 @@ const Requirements = () => (
     <Text>
       Make sure you have{' '}
       <TextLink
-        href="https://docs.typebot.io/embed/whatsapp/create-meta-app"
+        href="https://docs.typebot.io/deploy/whatsapp/create-meta-app"
         isExternal
       >
         created a WhatsApp Meta app

apps/builder/src/features/results/api/deleteResults.ts

@@ -18,7 +18,11 @@ export const deleteResults = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
       resultIds: z
         .string()
         .describe(

apps/builder/src/features/results/api/getResult.ts

@@ -17,7 +17,11 @@ export const getResult = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
       resultId: z.string(),
     })
   )

apps/builder/src/features/results/api/getResultLogs.ts

@@ -16,7 +16,11 @@ export const getResultLogs = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
       resultId: z.string(),
     })
   )

apps/builder/src/features/results/api/getResults.ts

@@ -19,7 +19,11 @@ export const getResults = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
       limit: z.coerce.number().min(1).max(maxLimit).default(50),
       cursor: z.string().optional(),
     })

apps/builder/src/features/typebot/api/deleteTypebot.ts

@@ -18,7 +18,11 @@ export const deleteTypebot = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
     })
   )
   .output(

apps/builder/src/features/typebot/api/getPublishedTypebot.ts

@@ -23,10 +23,15 @@ export const getPublishedTypebot = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
       migrateToLatestVersion: z
         .boolean()
         .optional()
+        .default(false)
         .describe(
           'If enabled, the typebot will be converted to the latest schema version'
         ),
@@ -36,11 +41,14 @@ export const getPublishedTypebot = authenticatedProcedure
     z.object({
       publishedTypebot: publicTypebotSchema.nullable(),
       version: z
-        .union([
-          publicTypebotSchemaV5._def.schema.shape.version,
-          publicTypebotSchemaV6.shape.version,
+        .enum([
+          ...publicTypebotSchemaV5._def.schema.shape.version._def.values,
+          publicTypebotSchemaV6.shape.version._def.value,
         ])
-        .optional(),
+        .optional()
+        .describe(
+          'Provides the version the published bot was migrated from if `migrateToLatestVersion` is set to `true`.'
+        ),
     })
   )
   .query(

apps/builder/src/features/typebot/api/getTypebot.ts

@@ -20,10 +20,15 @@ export const getTypebot = publicProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
       migrateToLatestVersion: z
         .boolean()
         .optional()
+        .default(false)
         .describe(
           'If enabled, the typebot will be converted to the latest schema version'
         ),

apps/builder/src/features/typebot/api/importTypebot.ts

@@ -35,14 +35,24 @@ const omittedProps = {
 const importingTypebotSchema = z.preprocess(
   preprocessTypebot,
   z.discriminatedUnion('version', [
-    typebotV5Schema._def.schema.omit(omittedProps).extend({
-      resultsTablePreferences: resultsTablePreferencesSchema.nullish(),
-      selectedThemeTemplateId: z.string().nullish(),
-    }),
-    typebotV6Schema.omit(omittedProps).extend({
-      resultsTablePreferences: resultsTablePreferencesSchema.nullish(),
-      selectedThemeTemplateId: z.string().nullish(),
-    }),
+    typebotV6Schema
+      .omit(omittedProps)
+      .extend({
+        resultsTablePreferences: resultsTablePreferencesSchema.nullish(),
+        selectedThemeTemplateId: z.string().nullish(),
+      })
+      .openapi({
+        title: 'Typebot V6',
+      }),
+    typebotV5Schema._def.schema
+      .omit(omittedProps)
+      .extend({
+        resultsTablePreferences: resultsTablePreferencesSchema.nullish(),
+        selectedThemeTemplateId: z.string().nullish(),
+      })
+      .openapi({
+        title: 'Typebot V5',
+      }),
   ])
 )
 
@@ -82,7 +92,11 @@ export const importTypebot = authenticatedProcedure
   })
   .input(
     z.object({
-      workspaceId: z.string(),
+      workspaceId: z
+        .string()
+        .describe(
+          '[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)'
+        ),
       typebot: importingTypebotSchema,
     })
   )

apps/builder/src/features/typebot/api/listTypebots.ts

@@ -17,7 +17,16 @@ export const listTypebots = authenticatedProcedure
       tags: ['Typebot'],
     },
   })
-  .input(z.object({ workspaceId: z.string(), folderId: z.string().optional() }))
+  .input(
+    z.object({
+      workspaceId: z
+        .string()
+        .describe(
+          '[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)'
+        ),
+      folderId: z.string().optional(),
+    })
+  )
   .output(
     z.object({
       typebots: z.array(

apps/builder/src/features/typebot/api/publishTypebot.ts

@@ -29,7 +29,11 @@ export const publishTypebot = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
     })
   )
   .output(

apps/builder/src/features/typebot/api/unpublishTypebot.ts

@@ -16,7 +16,11 @@ export const unpublishTypebot = authenticatedProcedure
   })
   .input(
     z.object({
-      typebotId: z.string(),
+      typebotId: z
+        .string()
+        .describe(
+          "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
+        ),
     })
   )
   .output(