From 894f47bb6cf07000a4376ecd7ff5b3a556c6f0ed Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 26 Aug 2026 20:18:26 +0000 Subject: [PATCH 1/7] docs: document bring your own model configuration for AI products --- assistant/configure.mdx | 23 ++++++++++++++++++++++- es/assistant/configure.mdx | 23 +++++++++++++++++++++++ fr/assistant/configure.mdx | 23 +++++++++++++++++++++++ zh/assistant/configure.mdx | 23 +++++++++++++++++++++++ 4 files changed, 91 insertions(+), 1 deletion(-) diff --git a/assistant/configure.mdx b/assistant/configure.mdx index 267202696..2182f44a5 100644 --- a/assistant/configure.mdx +++ b/assistant/configure.mdx @@ -1,7 +1,7 @@ --- title: "Configure the assistant" description: "Configure the AI assistant in your Mintlify dashboard: toggle availability, customize responses, add starter questions, set bot protection, and manage billing." -keywords: ["assistant", "settings", "deflection", "bot protection", "billing"] +keywords: ["assistant", "settings", "deflection", "bot protection", "billing", "BYOK", "bring your own model"] --- Configure the assistant on the [Assistant](https://app.mintlify.com/products/assistant) page of your dashboard. Manage billing and usage on the [Usage](https://app.mintlify.com/settings/organization/usage) page. @@ -97,6 +97,27 @@ Changes take up to 10 minutes to propagate. If you use custom [Content Security Policy headers](/deploy/csp-configuration), you must include `hcaptcha.com` and `*.hcaptcha.com` in your allowlist. +## Bring your own model + + + Bringing your own model is available on [Enterprise plans](https://mintlify.com/pricing?ref=byok). + + +By default, Mintlify selects and manages the model that powers the assistant. Bring your own model to run Mintlify AI products on a model and API key that you control. + +To configure your own model: + +1. Go to the [API keys](https://app.mintlify.com/settings/organization/api-keys) page of your dashboard. +2. In the **AI model** section, toggle **Bring your own model** on. +3. Select a provider: **Anthropic**, **OpenRouter**, or **OpenAI-compatible**. +4. If you select **OpenAI-compatible**, enter a provider name and the provider's base URL. The base URL must use HTTPS and point to a publicly reachable hostname. +5. Select a model from the list for your provider. +6. Enter your provider API key and select **Save**. + +Mintlify stores your API key securely and never displays it after saving. When you change models within the same provider, Mintlify reuses your saved key. When you change the provider or base URL, enter your key again. To rotate a key, enter a new key and save. + +Toggle **Bring your own model** off to delete your configuration and return to Mintlify-managed models. + ## Manage billing The assistant runs on credits. Each assistant message consumes credits, where a message is any user interaction with the assistant that receives a response. See [Credit pricing](/credits) for more information. diff --git a/es/assistant/configure.mdx b/es/assistant/configure.mdx index 44809e766..d708fb5c1 100644 --- a/es/assistant/configure.mdx +++ b/es/assistant/configure.mdx @@ -108,6 +108,29 @@ Los cambios tardan hasta 10 minutos en propagarse. Si usas [encabezados de Content Security Policy](/es/deploy/csp-configuration) personalizados, debes incluir `hcaptcha.com` y `*.hcaptcha.com` en tu lista de permitidos. +
+ ## Usa tu propio modelo +
+ + + Usar tu propio modelo está disponible en los [planes Enterprise](https://mintlify.com/pricing?ref=byok). + + +De forma predeterminada, Mintlify selecciona y administra el modelo que impulsa el assistant. Usa tu propio modelo para ejecutar los productos de IA de Mintlify con un modelo y una clave de API que tú controlas. + +Para configurar tu propio modelo: + +1. Ve a la página de [claves de API](https://app.mintlify.com/settings/organization/api-keys) de tu dashboard. +2. En la sección **AI model**, activa **Bring your own model**. +3. Selecciona un proveedor: **Anthropic**, **OpenRouter** u **OpenAI-compatible**. +4. Si seleccionas **OpenAI-compatible**, ingresa un nombre de proveedor y la URL base del proveedor. La URL base debe usar HTTPS y apuntar a un nombre de host accesible públicamente. +5. Selecciona un modelo de la lista de tu proveedor. +6. Ingresa la clave de API de tu proveedor y selecciona **Save**. + +Mintlify almacena tu clave de API de forma segura y nunca la muestra después de guardarla. Cuando cambias de modelo dentro del mismo proveedor, Mintlify reutiliza tu clave guardada. Cuando cambias el proveedor o la URL base, ingresa tu clave de nuevo. Para rotar una clave, ingresa una clave nueva y guarda. + +Desactiva **Bring your own model** para eliminar tu configuración y volver a los modelos administrados por Mintlify. +
## Administrar la facturación
diff --git a/fr/assistant/configure.mdx b/fr/assistant/configure.mdx index 261381061..6f83a25af 100644 --- a/fr/assistant/configure.mdx +++ b/fr/assistant/configure.mdx @@ -108,6 +108,29 @@ Les modifications prennent jusqu'à 10 minutes pour se propager. Si vous utilisez des [en-têtes Content Security Policy](/fr/deploy/csp-configuration) personnalisés, vous devez inclure `hcaptcha.com` et `*.hcaptcha.com` dans votre liste autorisée. +
+ ## Utiliser votre propre modèle +
+ + + L'utilisation de votre propre modèle est disponible avec les [forfaits Enterprise](https://mintlify.com/pricing?ref=byok). + + +Par défaut, Mintlify sélectionne et gère le modèle qui alimente l'assistant. Utilisez votre propre modèle pour exécuter les produits d'IA de Mintlify avec un modèle et une clé d'API que vous contrôlez. + +Pour configurer votre propre modèle : + +1. Rendez-vous sur la page [Clés d'API](https://app.mintlify.com/settings/organization/api-keys) de votre tableau de bord. +2. Dans la section **AI model**, activez **Bring your own model**. +3. Sélectionnez un fournisseur : **Anthropic**, **OpenRouter** ou **OpenAI-compatible**. +4. Si vous sélectionnez **OpenAI-compatible**, saisissez un nom de fournisseur et l'URL de base du fournisseur. L'URL de base doit utiliser HTTPS et pointer vers un nom d'hôte accessible publiquement. +5. Sélectionnez un modèle dans la liste de votre fournisseur. +6. Saisissez la clé d'API de votre fournisseur et sélectionnez **Save**. + +Mintlify stocke votre clé d'API de manière sécurisée et ne l'affiche jamais après l'enregistrement. Lorsque vous changez de modèle au sein du même fournisseur, Mintlify réutilise votre clé enregistrée. Lorsque vous changez de fournisseur ou d'URL de base, saisissez à nouveau votre clé. Pour effectuer la rotation d'une clé, saisissez une nouvelle clé et enregistrez. + +Désactivez **Bring your own model** pour supprimer votre configuration et revenir aux modèles gérés par Mintlify. +
## Gérer la facturation
diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index a6e45f6a8..e688df7c1 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -108,6 +108,29 @@ AI 助手可以根据用户正在查看的页面生成特定于页面的问题 如果你使用自定义的 [Content Security Policy 头](/zh/deploy/csp-configuration)，你必须在允许列表中包含 `hcaptcha.com` 和 `*.hcaptcha.com`。 +
+ ## 使用自己的模型 +
+ + + 使用自己的模型功能仅在 [Enterprise 方案](https://mintlify.com/pricing?ref=byok)中提供。 + + +默认情况下，Mintlify 会选择并管理为助手提供支持的模型。使用自己的模型，可以让 Mintlify 的 AI 产品运行在由你控制的模型和 API 密钥上。 + +配置自己的模型： + +1. 前往 dashboard 的 [API 密钥](https://app.mintlify.com/settings/organization/api-keys)页面。 +2. 在 **AI model** 部分，开启 **Bring your own model**。 +3. 选择一个提供商：**Anthropic**、**OpenRouter** 或 **OpenAI-compatible**。 +4. 如果选择 **OpenAI-compatible**，请输入提供商名称和提供商的基础 URL。基础 URL 必须使用 HTTPS 并指向可公开访问的主机名。 +5. 从提供商的列表中选择一个模型。 +6. 输入提供商的 API 密钥，然后选择 **Save**。 + +Mintlify 会安全地存储你的 API 密钥，保存后不会再显示。在同一提供商内更换模型时，Mintlify 会复用已保存的密钥。更换提供商或基础 URL 时，需要重新输入密钥。要轮换密钥，请输入新密钥并保存。 + +关闭 **Bring your own model** 可删除你的配置，并恢复使用由 Mintlify 管理的模型。 +
## 管理计费
From 3425d3d90f7a0b2bbe92cb87d81bd12d49cb4a1b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 26 Aug 2026 20:20:41 +0000 Subject: [PATCH 2/7] docs: mirror BYOK keywords in translated frontmatter --- es/assistant/configure.mdx | 2 +- fr/assistant/configure.mdx | 2 +- zh/assistant/configure.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/es/assistant/configure.mdx b/es/assistant/configure.mdx index d708fb5c1..a3296baf6 100644 --- a/es/assistant/configure.mdx +++ b/es/assistant/configure.mdx @@ -1,7 +1,7 @@ --- title: "Configurar el assistant" description: "Configura el assistant de IA en el dashboard de Mintlify: disponibilidad, respuestas personalizadas, preguntas iniciales, protección antibots y facturación." -keywords: ["assistant", "configuración", "derivación", "protección contra bots", "facturación"] +keywords: ["assistant", "configuración", "derivación", "protección contra bots", "facturación", "BYOK", "usa tu propio modelo"] --- Configura el assistant en la página [Assistant](https://dashboard.mintlify.com/products/assistant) de tu dashboard. Administra la facturación y el uso en la página [Uso](https://dashboard.mintlify.com/settings/organization/usage). diff --git a/fr/assistant/configure.mdx b/fr/assistant/configure.mdx index 6f83a25af..894d2accd 100644 --- a/fr/assistant/configure.mdx +++ b/fr/assistant/configure.mdx @@ -1,7 +1,7 @@ --- title: "Configurer l'assistant" description: "Configurez l'assistant IA dans le tableau de bord Mintlify : disponibilité, réponses personnalisées, questions de démarrage, anti-bots et facturation." -keywords: ["assistant", "paramètres", "redirection", "protection contre les bots", "facturation"] +keywords: ["assistant", "paramètres", "redirection", "protection contre les bots", "facturation", "BYOK", "utiliser votre propre modèle"] --- Configurez l'assistant sur la page [Assistant](https://dashboard.mintlify.com/products/assistant) de votre tableau de bord. Gérez la facturation et l'utilisation sur la page [Utilisation](https://dashboard.mintlify.com/settings/organization/usage). diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index e688df7c1..e301df15d 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -1,7 +1,7 @@ --- title: "配置 AI 助手" description: "在 Mintlify 仪表盘中配置 AI 助手：启用或停用助手、自定义响应内容、添加起始问题、设置机器人防护、管理速率限制以及查看助手用量与计费。" -keywords: ["assistant", "设置", "转接", "机器人防护", "计费"] +keywords: ["assistant", "设置", "转接", "机器人防护", "计费", "BYOK", "使用自己的模型"] --- 在仪表盘的 [Assistant](https://dashboard.mintlify.com/products/assistant) 页面配置 AI 助手。在[用量](https://dashboard.mintlify.com/settings/organization/usage)页面管理计费和用量。 From 896be55a93ce1f2aa7f0b6bbbdb2f99780874bab Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 27 Aug 2026 17:33:44 +0000 Subject: [PATCH 3/7] docs: clarify BYOK is a contracted Enterprise add-on --- assistant/configure.mdx | 2 +- es/assistant/configure.mdx | 2 +- fr/assistant/configure.mdx | 2 +- zh/assistant/configure.mdx | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/assistant/configure.mdx b/assistant/configure.mdx index 2182f44a5..a65001812 100644 --- a/assistant/configure.mdx +++ b/assistant/configure.mdx @@ -100,7 +100,7 @@ Changes take up to 10 minutes to propagate. ## Bring your own model - Bringing your own model is available on [Enterprise plans](https://mintlify.com/pricing?ref=byok). + Bringing your own model is an add-on for [Enterprise plans](https://mintlify.com/pricing?ref=byok). The **AI model** section appears in your dashboard only when the add-on is included in your contract. [Contact sales](mailto:sales@mintlify.com) to add it. By default, Mintlify selects and manages the model that powers the assistant. Bring your own model to run Mintlify AI products on a model and API key that you control. diff --git a/es/assistant/configure.mdx b/es/assistant/configure.mdx index a3296baf6..d78b3671a 100644 --- a/es/assistant/configure.mdx +++ b/es/assistant/configure.mdx @@ -113,7 +113,7 @@ Los cambios tardan hasta 10 minutos en propagarse. - Usar tu propio modelo está disponible en los [planes Enterprise](https://mintlify.com/pricing?ref=byok). + Usar tu propio modelo es un complemento para los [planes Enterprise](https://mintlify.com/pricing?ref=byok). La sección **AI model** aparece en tu dashboard solo cuando el complemento está incluido en tu contrato. [Contacta a ventas](mailto:sales@mintlify.com) para agregarlo. De forma predeterminada, Mintlify selecciona y administra el modelo que impulsa el assistant. Usa tu propio modelo para ejecutar los productos de IA de Mintlify con un modelo y una clave de API que tú controlas. diff --git a/fr/assistant/configure.mdx b/fr/assistant/configure.mdx index 894d2accd..ce5d1974b 100644 --- a/fr/assistant/configure.mdx +++ b/fr/assistant/configure.mdx @@ -113,7 +113,7 @@ Les modifications prennent jusqu'à 10 minutes pour se propager. - L'utilisation de votre propre modèle est disponible avec les [forfaits Enterprise](https://mintlify.com/pricing?ref=byok). + L'utilisation de votre propre modèle est une option complémentaire des [forfaits Enterprise](https://mintlify.com/pricing?ref=byok). La section **AI model** apparaît dans votre tableau de bord uniquement lorsque cette option est incluse dans votre contrat. [Contactez l'équipe commerciale](mailto:sales@mintlify.com) pour l'ajouter. Par défaut, Mintlify sélectionne et gère le modèle qui alimente l'assistant. Utilisez votre propre modèle pour exécuter les produits d'IA de Mintlify avec un modèle et une clé d'API que vous contrôlez. diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index e301df15d..bcb373672 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -113,7 +113,7 @@ AI 助手可以根据用户正在查看的页面生成特定于页面的问题 - 使用自己的模型功能仅在 [Enterprise 方案](https://mintlify.com/pricing?ref=byok)中提供。 + 使用自己的模型是 [Enterprise 方案](https://mintlify.com/pricing?ref=byok)的附加功能。只有当你的合同包含该附加功能时，dashboard 中才会显示 **AI model** 部分。请[联系销售团队](mailto:sales@mintlify.com)添加该功能。 默认情况下，Mintlify 会选择并管理为助手提供支持的模型。使用自己的模型，可以让 Mintlify 的 AI 产品运行在由你控制的模型和 API 密钥上。 From adb067e95aaffff6e44eeafb951f0f1def9723d9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 27 Aug 2026 22:59:13 +0000 Subject: [PATCH 4/7] Updated mintlify pages - Updated quickstart.mdx Mintlify-Source: dashboard-editor --- quickstart.mdx | 4 ---- 1 file changed, 4 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 9b1d56b45..cc64208b4 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -5,8 +5,6 @@ keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "se boost: 3 --- -import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; - After you complete this guide, you'll have a live documentation site ready to customize and update. @@ -30,7 +28,6 @@ After you complete this guide, you'll have a live documentation site ready to cu 2. Run `mint --version`. If the command is unavailable, install the CLI with `npm i -g mint` or `pnpm add -g mint`. If the command succeeds, run `mint update`. 3. Run `mint status` before starting authentication. If it already shows an organization, keep the existing session and do not create another account. 4. Run `mint login` if the user has an account. Otherwise, ask for their first name, last name, company, and email, then run: - ```bash mint signup \ --firstName \ @@ -38,7 +35,6 @@ After you complete this guide, you'll have a live documentation site ready to cu --company \ --email ``` - `mint signup` waits for email verification, so keep it running as a background process when your environment supports background commands. Tell the user to click the verification link and approve the CLI in the browser. Never invent signup details. 5. After the user finishes verification and onboarding, run `mint status` again. Confirm that it reports their email, organization, and subdomain. If the organization exists but no subdomain appears, ask the user to finish selecting or connecting a GitHub repository in the onboarding browser tab, then retry. 6. If the user has an existing documentation repository, clone or open it. Preserve its content. For a new local project, scaffold into a new, empty directory with either `mint new --name --theme ` or `mint new --template `. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files. From 5469330c15c43b8423f81960e823fd0155dcaa0b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 27 Aug 2026 23:21:07 +0000 Subject: [PATCH 5/7] Updated mintlify pages - Updated quickstart.mdx Mintlify-Source: dashboard-editor --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index cc64208b4..1ef946d9d 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,6 +1,6 @@ --- title: "Quickstart" -description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git." +description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git. " keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] boost: 3 --- From 4fe8dfbac132949978000a8c92a0fb580094ecb6 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 27 Aug 2026 23:29:22 +0000 Subject: [PATCH 6/7] Updated mintlify pages - Updated quickstart.mdx Mintlify-Source: dashboard-editor --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 1ef946d9d..e2fd58605 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,6 +1,6 @@ --- title: "Quickstart" -description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git. " +description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git. jfkdjfdjkj" keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] boost: 3 --- From 14af0fe62421b27ccc6766b1dfb41a218286d698 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 28 Aug 2026 00:07:19 +0000 Subject: [PATCH 7/7] docs: note OpenRouter default and provider compatibility for BYOK --- assistant/configure.mdx | 2 +- es/assistant/configure.mdx | 2 +- fr/assistant/configure.mdx | 2 +- quickstart.mdx | 6 +++++- zh/assistant/configure.mdx | 2 +- 5 files changed, 9 insertions(+), 5 deletions(-) diff --git a/assistant/configure.mdx b/assistant/configure.mdx index a65001812..d55e69dae 100644 --- a/assistant/configure.mdx +++ b/assistant/configure.mdx @@ -109,7 +109,7 @@ To configure your own model: 1. Go to the [API keys](https://app.mintlify.com/settings/organization/api-keys) page of your dashboard. 2. In the **AI model** section, toggle **Bring your own model** on. -3. Select a provider: **Anthropic**, **OpenRouter**, or **OpenAI-compatible**. +3. Select a provider: **OpenRouter**, **Anthropic**, or **OpenAI-compatible**. OpenRouter is selected by default and works with all Mintlify AI products. Anthropic and OpenAI-compatible providers have limited compatibility: not all AI products work with them. 4. If you select **OpenAI-compatible**, enter a provider name and the provider's base URL. The base URL must use HTTPS and point to a publicly reachable hostname. 5. Select a model from the list for your provider. 6. Enter your provider API key and select **Save**. diff --git a/es/assistant/configure.mdx b/es/assistant/configure.mdx index d78b3671a..63ee57e6f 100644 --- a/es/assistant/configure.mdx +++ b/es/assistant/configure.mdx @@ -122,7 +122,7 @@ Para configurar tu propio modelo: 1. Ve a la página de [claves de API](https://app.mintlify.com/settings/organization/api-keys) de tu dashboard. 2. En la sección **AI model**, activa **Bring your own model**. -3. Selecciona un proveedor: **Anthropic**, **OpenRouter** u **OpenAI-compatible**. +3. Selecciona un proveedor: **OpenRouter**, **Anthropic** u **OpenAI-compatible**. OpenRouter está seleccionado de forma predeterminada y funciona con todos los productos de IA de Mintlify. Los proveedores Anthropic y OpenAI-compatible tienen compatibilidad limitada: no todos los productos de IA funcionan con ellos. 4. Si seleccionas **OpenAI-compatible**, ingresa un nombre de proveedor y la URL base del proveedor. La URL base debe usar HTTPS y apuntar a un nombre de host accesible públicamente. 5. Selecciona un modelo de la lista de tu proveedor. 6. Ingresa la clave de API de tu proveedor y selecciona **Save**. diff --git a/fr/assistant/configure.mdx b/fr/assistant/configure.mdx index ce5d1974b..78a396747 100644 --- a/fr/assistant/configure.mdx +++ b/fr/assistant/configure.mdx @@ -122,7 +122,7 @@ Pour configurer votre propre modèle : 1. Rendez-vous sur la page [Clés d'API](https://app.mintlify.com/settings/organization/api-keys) de votre tableau de bord. 2. Dans la section **AI model**, activez **Bring your own model**. -3. Sélectionnez un fournisseur : **Anthropic**, **OpenRouter** ou **OpenAI-compatible**. +3. Sélectionnez un fournisseur : **OpenRouter**, **Anthropic** ou **OpenAI-compatible**. OpenRouter est sélectionné par défaut et fonctionne avec tous les produits d'IA de Mintlify. Les fournisseurs Anthropic et OpenAI-compatible ont une compatibilité limitée : tous les produits d'IA ne fonctionnent pas avec eux. 4. Si vous sélectionnez **OpenAI-compatible**, saisissez un nom de fournisseur et l'URL de base du fournisseur. L'URL de base doit utiliser HTTPS et pointer vers un nom d'hôte accessible publiquement. 5. Sélectionnez un modèle dans la liste de votre fournisseur. 6. Saisissez la clé d'API de votre fournisseur et sélectionnez **Save**. diff --git a/quickstart.mdx b/quickstart.mdx index e2fd58605..9b1d56b45 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,10 +1,12 @@ --- title: "Quickstart" -description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git. jfkdjfdjkj" +description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git." keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] boost: 3 --- +import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; + After you complete this guide, you'll have a live documentation site ready to customize and update. @@ -28,6 +30,7 @@ After you complete this guide, you'll have a live documentation site ready to cu 2. Run `mint --version`. If the command is unavailable, install the CLI with `npm i -g mint` or `pnpm add -g mint`. If the command succeeds, run `mint update`. 3. Run `mint status` before starting authentication. If it already shows an organization, keep the existing session and do not create another account. 4. Run `mint login` if the user has an account. Otherwise, ask for their first name, last name, company, and email, then run: + ```bash mint signup \ --firstName \ @@ -35,6 +38,7 @@ After you complete this guide, you'll have a live documentation site ready to cu --company \ --email ``` + `mint signup` waits for email verification, so keep it running as a background process when your environment supports background commands. Tell the user to click the verification link and approve the CLI in the browser. Never invent signup details. 5. After the user finishes verification and onboarding, run `mint status` again. Confirm that it reports their email, organization, and subdomain. If the organization exists but no subdomain appears, ask the user to finish selecting or connecting a GitHub repository in the onboarding browser tab, then retry. 6. If the user has an existing documentation repository, clone or open it. Preserve its content. For a new local project, scaffold into a new, empty directory with either `mint new --name --theme ` or `mint new --template `. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files. diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index bcb373672..9e9e1c76b 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -122,7 +122,7 @@ AI 助手可以根据用户正在查看的页面生成特定于页面的问题 1. 前往 dashboard 的 [API 密钥](https://app.mintlify.com/settings/organization/api-keys)页面。 2. 在 **AI model** 部分，开启 **Bring your own model**。 -3. 选择一个提供商：**Anthropic**、**OpenRouter** 或 **OpenAI-compatible**。 +3. 选择一个提供商：**OpenRouter**、**Anthropic** 或 **OpenAI-compatible**。默认选中 OpenRouter，它适用于所有 Mintlify AI 产品。Anthropic 和 OpenAI-compatible 提供商的兼容性有限：并非所有 AI 产品都能与它们配合使用。 4. 如果选择 **OpenAI-compatible**，请输入提供商名称和提供商的基础 URL。基础 URL 必须使用 HTTPS 并指向可公开访问的主机名。 5. 从提供商的列表中选择一个模型。 6. 输入提供商的 API 密钥，然后选择 **Save**。