From 1f2637adc02d83d0995a0eb36d6ada9c76edcf32 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 23 Sep 2026 14:27:21 -0700 Subject: [PATCH 1/5] docs: define projects in glossary and concepts Deployments are now called projects in the dashboard. Update the glossary and concepts pages to use "project" for the entity and reserve "deployment" for builds, noting where the old term still appears. Co-Authored-By: Claude Opus 5.5 (1M context) --- reference/concepts.mdx | 14 +++++++------- reference/glossary.mdx | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/reference/concepts.mdx b/reference/concepts.mdx index 64c02c6910..4f7820eb1b 100644 --- a/reference/concepts.mdx +++ b/reference/concepts.mdx @@ -1,7 +1,7 @@ --- title: "Concepts" description: "Learn how Mintlify connects your organization, documentation repository, editing workflows, previews, deployments, analytics, and AI features." -keywords: ["concepts", "how Mintlify works", "repository", "deployment", "publishing", "AI"] +keywords: ["concepts", "how Mintlify works", "repository", "project", "deployment", "publishing", "AI"] --- Mintlify turns content in a Git repository into a documentation site. You can work from the editor in your browser, your local development environment, or prompt the Mintlify agent in Slack. All three workflows update the same repository. Mintlify builds your repository content into optimized experiences for people and agents. @@ -15,16 +15,16 @@ flowchart LR Site --> AI["AI agents"] ``` -## Organizations, deployments, and sites +## Organizations, projects, and sites -An **organization** is the workspace for your team. It contains your members, organization-level settings, and one or more deployments. +An **organization** is the workspace for your team. It contains your members, organization-level settings, and one or more projects. -A **deployment** is a documentation project in your organization. It connects a repository, content directory, and deployment branch to a published site. An organization can have multiple deployments for separate products or documentation properties. +A **project** is a documentation site in your organization. It connects a repository, content directory, and deployment branch to a published site. An organization can have multiple projects for separate products or documentation properties. -A **live site** is the published output of a deployment. Mintlify provides a `.mintlify.site` URL by default. You can connect a [custom domain](/customize/custom-domain) for your site. Sites include your content, navigation, search, and any features you enable, such as the assistant or API playground. +A **live site** is the published output of a project. Mintlify provides a `.mintlify.site` URL by default. You can connect a [custom domain](/customize/custom-domain) for your site. Sites include your content, navigation, search, and any features you enable, such as the assistant or API playground. - The documentation sometimes uses **project** as a general name for a deployment and its connected repository, configuration, and site. + Projects were previously called deployments. Some dashboard settings and APIs still use **deployment** to refer to a project. ## The repository is the source of truth @@ -87,7 +87,7 @@ Mintlify provides separate AI features for reading, writing, automation, and ext | [Agent](/agent) | Documentation maintainers | Researches and proposes content or configuration updates | Yes | | [Automations](/automations/index) | Documentation maintainers | Runs the agent from a schedule, repository update, or integration event | Yes | | [Search MCP server](/ai/model-context-protocol) | Agents | Retrieves context from one published documentation site | No | -| [Admin MCP server](/ai/mintlify-mcp) | Agents | Reads and updates deployments through authenticated tools | Yes | +| [Admin MCP server](/ai/mintlify-mcp) | Agents | Reads and updates projects through authenticated tools | Yes | | [Mintlify Index](/search-index) | Agents | Retrieves current technical context across all public Mintlify sites and the web | No | ## Learn the terminology diff --git a/reference/glossary.mdx b/reference/glossary.mdx index 7bf8f0cf8f..2339bb2de4 100644 --- a/reference/glossary.mdx +++ b/reference/glossary.mdx @@ -10,7 +10,7 @@ Use this glossary as a quick reference for terms used in Mintlify and throughout ### Admin MCP server -An authenticated [Model Context Protocol](#model-context-protocol-mcp) server that lets authorized AI tools read and update content and settings across one or more deployments in an organization. Changes happen on a branch and require a pull request to merge. See [Admin MCP server](/ai/mintlify-mcp). +An authenticated [Model Context Protocol](#model-context-protocol-mcp) server that lets authorized AI tools read and update content and settings across one or more projects in an organization. Changes happen on a branch and require a pull request to merge. See [Admin MCP server](/ai/mintlify-mcp). ### Agent @@ -54,7 +54,7 @@ A reusable MDX element for presenting structured or interactive content, such as ### Content directory -The directory in a repository that contains `docs.json` and the files for a Mintlify deployment. It can be the repository root or a configured subdirectory, such as `docs/` in a monorepo. See [Monorepo setup](/deploy/monorepo). +The directory in a repository that contains `docs.json` and the files for a Mintlify project. It can be the repository root or a configured subdirectory, such as `docs/` in a monorepo. See [Monorepo setup](/deploy/monorepo). ### Context repository @@ -62,7 +62,7 @@ An additional repository that the agent can read for background information when ### Credits -Units that measure use of Mintlify AI features. Credits are pooled across an organization and shared by its deployments and members. See [Credits](/credits). +Units that measure use of Mintlify AI features. Credits are pooled across an organization and shared by its projects and members. See [Credits](/credits). ### Custom domain @@ -76,7 +76,7 @@ The authenticated Mintlify application where your team edits content, monitors d ### Deployment -A documentation project within a Mintlify organization. A deployment connects source content and a deployment branch to a live site. The term can also refer to a specific build being published. +A build of a project that Mintlify publishes. A production deployment updates the live site from the deployment branch, and a [preview deployment](#preview-deployment) publishes a temporary version for review. ### Deployment branch @@ -172,7 +172,7 @@ A standard format for describing HTTP APIs. Mintlify can generate endpoint pages ### Organization -A Mintlify workspace that contains team members, organization-level settings, shared credits, and one or more deployments. +A Mintlify workspace that contains team members, organization-level settings, shared credits, and one or more projects. ### Overlay @@ -190,11 +190,11 @@ A temporary, shareable version of a site built from a pull request or selected b ### Product -A top-level navigation structure for publishing documentation for multiple distinct products in one deployment. Each product has its own navigation. See [Products](/organize/navigation#products). +A top-level navigation structure for publishing documentation for multiple distinct products in one project. Each product has its own navigation. See [Products](/organize/navigation#products). ### Project -A general term for a Mintlify deployment and its connected repository, configuration, and site. In dashboard settings and APIs, **deployment** is usually the more specific term. +A documentation site within a Mintlify organization. A project connects source content and a deployment branch to a live site. Projects were previously called deployments, and some dashboard settings and APIs still use that term, such as the **Deployment name** setting and the `list_deployments` tool in the [Admin MCP server](#admin-mcp-server). ### Publish From 6ff4dd80443aba64cb1ebebf0928ef5933978651 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 24 Sep 2026 14:33:03 -0700 Subject: [PATCH 2/5] docs: drop renamed Deployment name setting from project definition Co-Authored-By: Claude Opus 5.5 (1M context) --- reference/concepts.mdx | 2 +- reference/glossary.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/concepts.mdx b/reference/concepts.mdx index 4f7820eb1b..113470f289 100644 --- a/reference/concepts.mdx +++ b/reference/concepts.mdx @@ -24,7 +24,7 @@ A **project** is a documentation site in your organization. It connects a reposi A **live site** is the published output of a project. Mintlify provides a `.mintlify.site` URL by default. You can connect a [custom domain](/customize/custom-domain) for your site. Sites include your content, navigation, search, and any features you enable, such as the assistant or API playground. - Projects were previously called deployments. Some dashboard settings and APIs still use **deployment** to refer to a project. + Projects were previously called deployments. Some APIs and tools still use **deployment** to refer to a project. ## The repository is the source of truth diff --git a/reference/glossary.mdx b/reference/glossary.mdx index 2339bb2de4..1839fa6b36 100644 --- a/reference/glossary.mdx +++ b/reference/glossary.mdx @@ -194,7 +194,7 @@ A top-level navigation structure for publishing documentation for multiple disti ### Project -A documentation site within a Mintlify organization. A project connects source content and a deployment branch to a live site. Projects were previously called deployments, and some dashboard settings and APIs still use that term, such as the **Deployment name** setting and the `list_deployments` tool in the [Admin MCP server](#admin-mcp-server). +A documentation site within a Mintlify organization. A project connects source content and a deployment branch to a live site. Projects were previously called deployments, and some APIs and tools still use that term, such as the `list_deployments` tool in the [Admin MCP server](#admin-mcp-server). ### Publish From bc71f8e8aa7fb77b02937d86ba2ff85b08978acd Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 24 Sep 2026 14:39:27 -0700 Subject: [PATCH 3/5] docs: update links and labels for consolidated dashboard settings Point Add-ons, authentication, SSO/SCIM, GitHub App, and GitLab OAuth references at their current settings pages and match current UI labels. Co-Authored-By: Claude Opus 5.5 (1M context) --- automations/manage.mdx | 2 +- automations/reference.mdx | 2 +- dashboard/network-access.mdx | 12 +++---- dashboard/scim.mdx | 8 ++--- dashboard/session-security.mdx | 4 +-- dashboard/sso.mdx | 20 +++++------ deploy/authentication-setup.mdx | 41 +++++++++++----------- help-center/configure-oauth-with-auth0.mdx | 2 +- optimize/feedback.mdx | 6 ++-- snippets/gitlab-automation-setup.mdx | 2 +- snippets/gitlab-workflow-setup.mdx | 2 +- 11 files changed, 50 insertions(+), 51 deletions(-) diff --git a/automations/manage.mdx b/automations/manage.mdx index 2060663a38..664c311a94 100644 --- a/automations/manage.mdx +++ b/automations/manage.mdx @@ -61,7 +61,7 @@ Select the mode in the **After automation runs** section of the automation's con For custom automations and some predefined automations, you can add context repositories. Context repositories are additional source code repositories the agent reads when the automation runs. This is useful when your automation prompt references code, APIs, or other content that lives outside your project repository. -You can add up to 10 context repositories per automation. For each GitHub repository, install the Mintlify GitHub App. Add repositories on the [GitHub App settings](https://app.mintlify.com/settings/organization/github-app) page. +You can add up to 10 context repositories per automation. For each GitHub repository, install the Mintlify GitHub App. Add repositories in the **GitHub app** section of the [Git settings](https://app.mintlify.com/settings/project/git-settings) page. ### Integrations diff --git a/automations/reference.mdx b/automations/reference.mdx index 80bb2d6bd9..2fb41c7a38 100644 --- a/automations/reference.mdx +++ b/automations/reference.mdx @@ -53,7 +53,7 @@ Reviews question trends from your [assistant](/assistant/index) to identify gaps Reviews page [feedback](/optimize/feedback), including thumbs ratings and written comments, and updates content where users have reported problems. The agent focuses on pages with recurring negative signals rather than one-off feedback, so results improve as feedback accumulates. -You must enable feedback collection on the [Add-ons](https://app.mintlify.com/products/addons) page before you can use this automation. +You must enable feedback collection in the **Feedback** section of the [General](https://app.mintlify.com/settings/project/general) settings page before you can use this automation. ### Update from support feedback diff --git a/dashboard/network-access.mdx b/dashboard/network-access.mdx index 61aa8e4800..649a1bef16 100644 --- a/dashboard/network-access.mdx +++ b/dashboard/network-access.mdx @@ -9,7 +9,7 @@ keywords: ["IP allowlist", "network access", "CIDR", "IP restrictions", "securit Dashboard access policies require an [Enterprise plan](https://mintlify.com/pricing?ref=network-access). -Control how organization members access the Mintlify dashboard. You can restrict access to trusted IP addresses and set how long dashboard sessions stay valid. Manage both policies on the **Policies** tab of the [Identity & access](https://app.mintlify.com/settings/organization/access) page in your dashboard. +Control how organization members access the Mintlify dashboard. You can restrict access to trusted IP addresses and set how long dashboard sessions stay valid. Manage both policies in the **Policies** section of the [Security](https://app.mintlify.com/settings/organization/access) page in your dashboard. ## IP allowlist @@ -29,11 +29,11 @@ Both IPv4 and IPv6 addresses are supported. ### Configure the IP allowlist - Add your current IP address to the allowlist before enabling it. If your address is not on the list, you can lock yourself out of the dashboard. The **Policies** tab displays your current IP address to help you avoid this. + Add your current IP address to the allowlist before enabling it. If your address is not on the list, you can lock yourself out of the dashboard. The **Policies** section displays your current IP address to help you avoid this. -1. In your Mintlify dashboard, navigate to the [Identity & access](https://app.mintlify.com/settings/organization/access) page. -2. On the **Policies** tab, under **Allowed IP addresses**, enter an individual IP address (for example, `203.0.113.7`) or a CIDR range (for example, `10.0.0.0/8`). +1. In your Mintlify dashboard, navigate to the [Security](https://app.mintlify.com/settings/organization/access) page. +2. In the **Policies** section, under **Allowed IP addresses**, enter an individual IP address (for example, `203.0.113.7`) or a CIDR range (for example, `10.0.0.0/8`). 3. Click **Add**. 4. Repeat for each address or range you want to allow. 5. Enable the allowlist to begin enforcing it. @@ -49,8 +49,8 @@ Both limits accept values from 5 minutes to 14 days. ### Configure session lifetimes -1. In your Mintlify dashboard, navigate to the [Identity & access](https://app.mintlify.com/settings/organization/access) page. -2. On the **Policies** tab, under **Session lifetimes**, toggle on **Maximum session lifetime** or **Idle session timeout**. +1. In your Mintlify dashboard, navigate to the [Security](https://app.mintlify.com/settings/organization/access) page. +2. In the **Policies** section, under **Session lifetimes**, toggle on **Maximum session lifetime** or **Idle session timeout**. 3. Set a duration for each limit that you enable. 4. Click **Save**. diff --git a/dashboard/scim.mdx b/dashboard/scim.mdx index 9f86024855..3608ea03c6 100644 --- a/dashboard/scim.mdx +++ b/dashboard/scim.mdx @@ -20,7 +20,7 @@ Mintlify's SCIM endpoint works with any SCIM 2.0-compliant identity provider tha - In your Mintlify dashboard, navigate to the [SCIM](https://app.mintlify.com/settings/organization/scim) tab of the "Identity & access" page. + In your Mintlify dashboard, navigate to the **SCIM** section of the [Security](https://app.mintlify.com/settings/organization/access) page. Click **Configure SCIM**. Mintlify generates a **SCIM base URL** and a **bearer token**. @@ -67,7 +67,7 @@ Mintlify's SCIM endpoint works with any SCIM 2.0-compliant identity provider tha Assign [roles](/dashboard/roles) to users based on their identity provider group membership. -1. In the Mintlify dashboard, navigate to the [SCIM](https://app.mintlify.com/settings/organization/scim) tab of the "Identity & access" page. +1. In the Mintlify dashboard, navigate to the **SCIM** section of the [Security](https://app.mintlify.com/settings/organization/access) page. 2. In the "Group-to-role mappings" section, click **Add mapping**. 3. Enter the identity provider group name and select a role. @@ -79,7 +79,7 @@ You can edit or remove a mapping at any time. This mapping is one-directional an Rotate the bearer token if it's exposed or as part of routine credential hygiene. -1. Navigate to the [SCIM](https://app.mintlify.com/settings/organization/scim) tab of the "Identity & access" page. +1. Navigate to the **SCIM** section of the [Security](https://app.mintlify.com/settings/organization/access) page. 2. Click **Rotate token**. 3. Copy the new token and update your identity provider's SCIM configuration. @@ -89,7 +89,7 @@ Rotate the bearer token if it's exposed or as part of routine credential hygiene ## Disable SCIM -1. Navigate to the [SCIM](https://app.mintlify.com/settings/organization/scim) tab of the "Identity & access" page. +1. Navigate to the **SCIM** section of the [Security](https://app.mintlify.com/settings/organization/access) page. 2. Toggle SCIM off. Disabling SCIM stops new provisioning and deprovisioning events from your identity provider. Existing dashboard members keep their current access until removed manually or through another method. diff --git a/dashboard/session-security.mdx b/dashboard/session-security.mdx index 0045d6c006..ee92420c1c 100644 --- a/dashboard/session-security.mdx +++ b/dashboard/session-security.mdx @@ -17,7 +17,7 @@ Each setting has its own enable toggle. If a setting is disabled, Mintlify's def ## Configure session lifetimes -To review or change session lifetimes, go to the **Policies** tab of the [Identity & access](https://app.mintlify.com/settings/organization/access?tab=policies) page in your dashboard. +To review or change session lifetimes, go to the **Policies** section of the [Security](https://app.mintlify.com/settings/organization/access) page in your dashboard. For each setting, use the toggle to enable or disable it. Enter a value, select a unit (minutes, hours, days, or weeks for maximum lifetime; minutes, hours, or days for idle timeout), and click **Save**. Disabling a setting and saving clears it so Mintlify's default takes over. @@ -50,7 +50,7 @@ Use the IP allowlist to restrict dashboard access to a set of trusted networks. If your current IP address is not on the allowlist, you can lock yourself out of the dashboard. Confirm your IP is included before saving. -To configure the allowlist, go to the **Policies** tab of the [Identity & access](https://app.mintlify.com/settings/organization/access?tab=policies) page in your dashboard. +To configure the allowlist, go to the **Policies** section of the [Security](https://app.mintlify.com/settings/organization/access) page in your dashboard. - **Add an entry**: Enter an IPv4 or IPv6 address, or a CIDR range (for example, `203.0.113.7` or `10.0.0.0/8`), then click **Add**. Adding the first entry enables the allowlist. - **Remove an entry**: Click the **×** on any entry. Removing the last entry disables the allowlist. diff --git a/dashboard/sso.mdx b/dashboard/sso.mdx index dcfb6c5aee..c086154886 100644 --- a/dashboard/sso.mdx +++ b/dashboard/sso.mdx @@ -16,7 +16,7 @@ Enterprise admins can configure Security Assertion Markup Language (SAML) SSO fo - 1. In your Mintlify dashboard, navigate to the [Identity & access](https://app.mintlify.com/settings/organization/sso) page. + 1. In your Mintlify dashboard, navigate to the [Security](https://app.mintlify.com/settings/organization/access) page. 2. Click **Configure**. 3. Select **Okta SAML**. 4. Copy the **Single sign on URL** and **Audience URI**. @@ -47,7 +47,7 @@ Enterprise admins can configure Security Assertion Markup Language (SAML) SSO fo - 1. In your Mintlify dashboard, navigate to the [Identity & access](https://app.mintlify.com/settings/organization/sso) page. + 1. In your Mintlify dashboard, navigate to the [Security](https://app.mintlify.com/settings/organization/access) page. 2. Click **Configure**. 3. Select **Microsoft Entra ID SAML**. 4. Copy the **Single sign on URL** and **Audience URI**. @@ -96,7 +96,7 @@ When you enable JIT (just-in-time) provisioning, Mintlify automatically adds use JIT provisioning only works when users start the login from their identity provider (IdP). Users must sign in from your identity provider (Okta dashboard or Microsoft Entra portal) rather than starting from the Mintlify login page. -To enable JIT provisioning, you must have SSO enabled. In your dashboard, navigate to the [Identity & access](https://app.mintlify.com/settings/organization/sso) page. Set up SSO, then enable JIT provisioning. +To enable JIT provisioning, you must have SSO enabled. In your dashboard, navigate to the [Security](https://app.mintlify.com/settings/organization/access) page. Set up SSO, then enable JIT provisioning. ## Verified domains @@ -106,8 +106,8 @@ You can add up to 25 verified domains per organization. The **Verified domains** section appears only after your SSO connection is active. [Configure SSO](#configure-sso) before adding domains. -1. Navigate to the [Identity & access](https://app.mintlify.com/settings/organization/sso) page in your dashboard. -2. On the **SSO** tab, in the **Verified domains** section, enter the domain (for example, `example.com`) and click **Add**. +1. Navigate to the [Security](https://app.mintlify.com/settings/organization/access) page in your dashboard. +2. In the **SSO** section, under **Verified domains**, enter the domain (for example, `example.com`) and click **Add**. 3. Mintlify generates a verification token. In your DNS provider, create a TXT record with the name `_mintlify-verification.example.com` and the token as the value. Some DNS providers append the domain automatically. If yours does, enter just `_mintlify-verification` as the record name. 4. Return to the dashboard and click **Verify**. The status changes from **Pending** to **Verified** once the record propagates. @@ -117,9 +117,9 @@ To remove a domain, click the delete button beside it. To require everyone in your organization to sign in through your identity provider, turn on **Require SSO**. When **Require SSO** is on, Mintlify rejects password, magic link, and Google OAuth sign-ins. -1. Navigate to the [Identity & access](https://app.mintlify.com/settings/organization/sso) page in your dashboard. +1. Navigate to the [Security](https://app.mintlify.com/settings/organization/access) page in your dashboard. 2. Confirm that SSO works end-to-end. In a private browser window, sign in to your Mintlify dashboard from your identity provider's app catalog (IdP-initiated). Then sign in from the [Mintlify login page](https://app.mintlify.com/login) using an email on a verified domain (service provider (SP)-initiated). Both flows should redirect through your identity provider and land you in the dashboard. -3. On the **SSO** tab, in the **Sign-in policy** section, turn on **Require SSO**. +3. In the **SSO** section, turn on **Require SSO**. You can only require SSO after configuring an SSO connection. Requiring SSO does not check whether members can still sign in, so add break-glass access for at least one admin before turning it on. @@ -131,8 +131,8 @@ To stop requiring SSO, toggle the setting off. Other sign-in methods become avai Designate members who can bypass SSO and sign in with a password or magic link. Use break-glass access to recover access if your identity provider has an outage. It also helps if a misconfiguration locks members out. -1. Navigate to the [Identity & access](https://app.mintlify.com/settings/organization/sso) page in your dashboard. -2. On the **SSO** tab, in the **Break-glass access** section, enter the email address of a member who should retain non-SSO access and click **Add**. +1. Navigate to the [Security](https://app.mintlify.com/settings/organization/access) page in your dashboard. +2. In the **SSO** section, under **Break-glass emails**, enter the email address of a member who should retain non-SSO access and click **Add**. Each break-glass email must belong to an existing member of your organization. Break-glass access only takes effect while Require SSO is on. @@ -195,7 +195,7 @@ Once configured, Mintlify maps the group names from the SAML assertion to roles ## Change or remove SSO provider -1. Navigate to the [Identity & access](https://app.mintlify.com/settings/organization/sso) page in your dashboard. +1. Navigate to the [Security](https://app.mintlify.com/settings/organization/access) page in your dashboard. 2. Click **Configure**. 3. Select your preferred SSO provider or no SSO. diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index 0e5b9eaeaa..7e02816bef 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -47,11 +47,11 @@ Use this comparison to pick the method that fits your use case. See [Feature ava - 1. In your dashboard, go to [Authentication](https://app.mintlify.com/products/authentication). - 2. In the **Authentication method** section, set site visibility to **Private**. - 3. Click **Password**. + 1. In your dashboard, go to [Access](https://app.mintlify.com/settings/project/authentication). + 2. Set **Visibility** to **Private**. + 3. Set **Method** to **Password**. 4. Enter a secure password. - 5. Click **Save changes**. + 5. Click **Save**. After you save, your site redeploys. When it finishes deploying, anyone who visits your site must enter the password to access your content. @@ -75,10 +75,10 @@ You host your documentation at `docs.foo.com` and you need basic access control - 1. In your dashboard, go to [Authentication](https://app.mintlify.com/products/authentication). - 2. In the **Authentication method** section, set site visibility to **Private**. - 3. Click **Authenticated**. - 4. Click **Save changes**. + 1. In your dashboard, go to [Access](https://app.mintlify.com/settings/project/authentication). + 2. Set **Visibility** to **Private**. + 3. Set **Method** to **Authenticated**. + 4. Click **Save**. After you save, your site redeploys. When it finishes deploying, anyone who visits your site must log in to your Mintlify organization to access your content. @@ -107,26 +107,25 @@ You host your documentation at `docs.foo.com` and your entire team has access to - 1. In your dashboard, go to [Authentication](https://app.mintlify.com/products/authentication). - 2. In the **Authentication method** section, set site visibility to **Private**. - 3. Click **Custom**. + 1. In your dashboard, go to [Access](https://app.mintlify.com/settings/project/authentication). + 2. Set **Visibility** to **Private**. + 3. Set **Method** to **Custom**. 4. Click **OAuth**. 5. Configure these fields: * **Authorization URL**: Your OAuth endpoint. * **Client ID**: Your OAuth 2.0 client identifier. - * **Client Secret**: Your OAuth 2.0 client secret. + * **Client secret**: Your OAuth 2.0 client secret. * **Scopes** (optional): Permissions to request. Copy the **entire** scope string (for example, for a scope like `provider.users.docs`, copy the complete `provider.users.docs`). Use multiple scopes if you need different access levels. * **Additional authorization parameters** (optional): Additional query parameters to add to the initial authorization request. * **Token URL**: Your OAuth token exchange endpoint. * **Info API URL** (optional): Endpoint on your server that Mintlify calls to retrieve user info. Use this field for group-based access control. If omitted, the OAuth flow only verifies identity. * **Logout URL** (optional): The native logout URL for your OAuth provider. When users log out, Mintlify validates the logout redirect against this configured URL for security. The redirect only succeeds if it exactly matches the configured `logoutUrl`. If you do not configure a logout URL, users redirect to `/login`. Mintlify redirects users with a `GET` request and does not append query parameters. Include any parameters (for example, `returnTo`) directly in the URL. - * **Redirect URL** (optional): The URL to redirect users to after authentication. - 6. Click **Save changes**. + 6. Click **Save**. After you configure your OAuth settings, your site redeploys. When it finishes deploying, anyone who visits your site must log in to your OAuth provider to access your content. - 1. Copy the **Redirect URL** from your [authentication settings](https://app.mintlify.com/products/authentication). + 1. Copy the **Redirect URL** from your [Access settings](https://app.mintlify.com/settings/project/authentication). 2. Add the redirect URL as an authorized redirect URL for your OAuth server. @@ -137,7 +136,7 @@ You host your documentation at `docs.foo.com` and your entire team has access to Mintlify calls this endpoint with the OAuth access token to retrieve user information. No additional query parameters are sent. - Add this endpoint URL to the **Info API URL** field in your [authentication settings](https://app.mintlify.com/products/authentication). + Add this endpoint URL to the **Info API URL** field in your [Access settings](https://app.mintlify.com/settings/project/authentication). @@ -145,7 +144,7 @@ You host your documentation at `docs.foo.com` and your entire team has access to If your identity provider includes group membership in the ID token or access token, you can use those claims instead of an Info API URL. This option is available for OAuth configurations that use a client secret. -When configuring OAuth token claims for your deployment, use values such as: +When configuring OAuth token claims for your project, use values such as: ```json { @@ -206,13 +205,13 @@ You host your documentation at `docs.foo.com` and you have an existing OAuth ser - 1. In your dashboard, go to [Authentication](https://app.mintlify.com/products/authentication). - 2. In the **Authentication method** section, set site visibility to **Private**. - 3. Click **Custom**. + 1. In your dashboard, go to [Access](https://app.mintlify.com/settings/project/authentication). + 2. Set **Visibility** to **Private**. + 3. Set **Method** to **Custom**. 4. Click **JWT**. 5. Enter the URL of your existing login flow. 6. To offer more than one login flow, click **Add login URL** and enter a display name and URL for each option. You can configure up to 10 login URLs. - 7. Click **Save changes**. + 7. Click **Save**. 8. Click **Generate new key**. 9. Store your key securely where your backend can access it. diff --git a/help-center/configure-oauth-with-auth0.mdx b/help-center/configure-oauth-with-auth0.mdx index fd495af7fa..9a04531821 100644 --- a/help-center/configure-oauth-with-auth0.mdx +++ b/help-center/configure-oauth-with-auth0.mdx @@ -20,7 +20,7 @@ OAuth 2.0 authentication is available on the Enterprise plan. ## Map Auth0 to Mintlify's OAuth fields -In your Mintlify dashboard, go to [Authentication](https://app.mintlify.com/products/authentication), set site visibility to **Private**, and select **Custom** → **OAuth**. Fill in the fields with the following Auth0 values. Replace `YOUR_AUTH0_DOMAIN` with your tenant domain. +In your Mintlify dashboard, go to the [Access](https://app.mintlify.com/settings/project/authentication) settings page, set site visibility to **Private**, and select **Custom** → **OAuth**. Fill in the fields with the following Auth0 values. Replace `YOUR_AUTH0_DOMAIN` with your tenant domain. | Mintlify field | Auth0 value | |---|---| diff --git a/optimize/feedback.mdx b/optimize/feedback.mdx index 63c6e50109..27c689748d 100644 --- a/optimize/feedback.mdx +++ b/optimize/feedback.mdx @@ -38,10 +38,10 @@ Review your feedback data to: If you disable telemetry in your `docs.json` file, you cannot enable feedback features. -To collect and view feedback from users, you must enable feedback from the [Add-ons](https://app.mintlify.com/products/addons) page in your dashboard. +To collect and view feedback from users, you must enable feedback in the **Feedback** section of the [General](https://app.mintlify.com/settings/project/general) settings page in your dashboard. -1. Navigate to the [Add-ons](https://app.mintlify.com/products/addons) page. -2. Enable your desired feedback types. +1. Navigate to the [General](https://app.mintlify.com/settings/project/general) settings page. +2. In the **Feedback** section, enable your desired feedback types. * **Thumbs rating**: Simple thumbs up/down voting to gauge overall satisfaction with pages. * **Edit suggestions**: Allow users to suggest edits to your documentation. Only available for public repositories. * **Raise issues**: Allow users to create issues directly from your site. Only available for public repositories. diff --git a/snippets/gitlab-automation-setup.mdx b/snippets/gitlab-automation-setup.mdx index b8897b431b..4716fa8427 100644 --- a/snippets/gitlab-automation-setup.mdx +++ b/snippets/gitlab-automation-setup.mdx @@ -1,6 +1,6 @@ ## GitLab setup -To use GitLab repositories in an automation, connect each project through the [GitLab OAuth](https://app.mintlify.com/settings/organization/gitlab-oauth) settings page. Connect every repository the automation touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project. +To use GitLab repositories in an automation, connect each project in the **GitLab OAuth** section of the [Git settings](https://app.mintlify.com/settings/project/git-settings) page. Connect every repository the automation touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project. Automations require a paid GitLab tier. The agent uses short-lived project access tokens for repository access, which GitLab's Free plan does not support. diff --git a/snippets/gitlab-workflow-setup.mdx b/snippets/gitlab-workflow-setup.mdx index a11ec9a830..6ac11a4ea1 100644 --- a/snippets/gitlab-workflow-setup.mdx +++ b/snippets/gitlab-workflow-setup.mdx @@ -1,6 +1,6 @@ ## GitLab setup -To use GitLab repositories in a workflow, connect each project through the [GitLab OAuth](https://app.mintlify.com/settings/organization/gitlab-oauth) settings page. Connect every repository the workflow touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project. +To use GitLab repositories in a workflow, connect each project in the **GitLab OAuth** section of the [Git settings](https://app.mintlify.com/settings/project/git-settings) page. Connect every repository the workflow touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project. Workflows require a paid GitLab tier. The agent uses short-lived project access tokens for repository access, which GitLab's Free plan does not support. From aee31d1de8e998c4d8babcf94d4cba7bd34af56f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 24 Sep 2026 14:39:27 -0700 Subject: [PATCH 4/5] docs: use project instead of deployment for the site entity The dashboard now calls deployments projects. Update prose, headings, and UI labels where deployment meant the site entity. Keep deployment for builds, preview deployments, deployment branches, and API/tool names. Co-Authored-By: Claude Opus 5.5 (1M context) --- advanced-support.mdx | 2 +- .../context/skills/mintlify/SKILL.md | 8 ++-- .../context/skills/mintlify/reference/cli.md | 2 +- .../mintlify/reference/configuration.md | 4 +- .../skills/mintlify/reference/navigation.md | 2 +- agent/index.mdx | 8 ++-- agent/slack.mdx | 16 ++++---- ai/bring-your-own-model.mdx | 14 +++---- ai/contextual-menu.mdx | 2 +- ai/mintlify-mcp.mdx | 38 +++++++++---------- analytics/streaming.mdx | 14 +++---- api-playground/openapi-setup.mdx | 2 +- api/introduction.mdx | 2 +- api/static-export/overview.mdx | 2 +- assistant/configure.mdx | 2 +- assistant/index.mdx | 2 +- assistant/narration.mdx | 2 +- assistant/skills.mdx | 2 +- assistant/widget.mdx | 2 +- cli/commands.mdx | 6 +-- cli/index.mdx | 2 +- contact-support.mdx | 2 +- credits.mdx | 20 +++++----- customize/custom-domain.mdx | 4 +- dashboard/audit-logs.mdx | 2 +- deploy/bitbucket.mdx | 4 +- deploy/ci.mdx | 4 +- deploy/deployments.mdx | 23 +++++------ deploy/ghes.mdx | 6 +-- deploy/gitlab-self-hosted.mdx | 2 +- deploy/gitlab.mdx | 2 +- deploy/monorepo.mdx | 2 +- deploy/multi-repo.mdx | 26 ++++++------- deploy/reverse-proxy.mdx | 2 +- deploy/rollbacks.mdx | 4 +- deploy/self-host.mdx | 4 +- editor/agent.mdx | 4 +- editor/publish.mdx | 4 +- editor/settings.mdx | 2 +- ...-blocked-by-git-provider-ip-allow-list.mdx | 6 +-- ...ns-pull-requests-against-deploy-branch.mdx | 4 +- ...i-rename-my-deployment-or-organization.mdx | 34 ++++++++--------- ...lready-claimed-by-another-organization.mdx | 18 ++++----- ...-addresses-for-git-provider-allowlists.mdx | 2 +- ...issing-when-creating-second-deployment.mdx | 14 +++---- migration-services/go-live-checklist.mdx | 2 +- optimize/seo.mdx | 4 +- organize/navigation.mdx | 4 +- organize/pages.mdx | 6 +-- organize/related-pages.mdx | 2 +- organize/settings-reference.mdx | 2 +- organize/settings-structure.mdx | 2 +- quickstart.mdx | 2 +- snippets/migration-launch-checklist.mdx | 2 +- 54 files changed, 177 insertions(+), 178 deletions(-) diff --git a/advanced-support.mdx b/advanced-support.mdx index b2c2ce495d..e90749ea60 100644 --- a/advanced-support.mdx +++ b/advanced-support.mdx @@ -126,7 +126,7 @@ Mintlify will use commercially reasonable efforts to meet the following service - A P0 is a complete service outage or security incident affecting your Mintlify deployment. Mintlify determines P0 classification. We monitor our systems continuously and proactively open P0 incidents when our criteria match. Real-time status is always available at [status.mintlify.com](https://status.mintlify.com). + A P0 is a complete service outage or security incident affecting your Mintlify project. Mintlify determines P0 classification. We monitor our systems continuously and proactively open P0 incidents when our criteria match. Real-time status is always available at [status.mintlify.com](https://status.mintlify.com). diff --git a/agent-context/context/skills/mintlify/SKILL.md b/agent-context/context/skills/mintlify/SKILL.md index 9b8b0a5dd1..62dd63409a 100644 --- a/agent-context/context/skills/mintlify/SKILL.md +++ b/agent-context/context/skills/mintlify/SKILL.md @@ -37,24 +37,24 @@ Tools: Write access to a Mintlify project. Requires OAuth on first use. Complete authentication in the browser when prompted. -Use this server when the user wants to edit their Mintlify content, restructure navigation, or open a pull request. Content changes buffer on a session branch; nothing touches the deploy branch until `save`. Deployment management changes made through code mode apply immediately to the live deployment without a branch or pull request. +Use this server when the user wants to edit their Mintlify content, restructure navigation, or open a pull request. Content changes buffer on a session branch; nothing touches the deploy branch until `save`. Project management changes made through code mode apply immediately to the live project without a branch or pull request. Workflow: call `checkout` first (always), then use `read`/`search`/`edit_page`/`write_page`/`list_nodes`/`create_node`/`update_node`/`move_node`/`delete_node`/`update_config` to make changes, then call `save` to publish (or `discard_session` to abandon). Key tools: - **`checkout`** — Start a session on a branch (required first call). Returns an `editorUrl` to preview changes live. - **`list_branches`** — List existing branches; call before `checkout` to attach to one. -- **`list_deployments`** — Discover which deployment(s) this connection can access. +- **`list_deployments`** — Discover which project(s) this connection can access. - **`read`** / **`search`** — Fetch a page's MDX or search across pages. - **`edit_page`** / **`write_page`** — Apply targeted edits or overwrite a page. - **`list_nodes`** / **`create_node`** / **`update_node`** / **`move_node`** / **`delete_node`** — Manage the navigation tree. - **`update_config`** — Modify `docs.json` (theme, nav roots, integrations, SEO). -- **`search_code_operations`** / **`execute_code`** — Code mode for deployment-level operations with no dedicated tool (workflows, settings, members, billing, integrations, analytics, private-page sharing). Search available methods, then run a TypeScript script against them. No `checkout` required. Writes apply immediately to the live deployment, so confirm the intended change first. +- **`search_code_operations`** / **`execute_code`** — Code mode for project-level operations with no dedicated tool (workflows, settings, members, billing, integrations, analytics, private-page sharing). Search available methods, then run a TypeScript script against them. No `checkout` required. Writes apply immediately to the live project, so confirm the intended change first. Private pages: `list_nodes` accepts `visibility: "private"` to list the private pages and folders the OAuth user can access (ignores other filters, returns each node's `role`). `read`, `edit_page`, `write_page`, `update_node`, and `delete_node` accept `private-page-` or `private-folder-` node ids; `create_node` accepts `visibility: "private"` with `data.type: "page"` or `"group"`. Private-page operations require an OAuth session (the admin MCP rejects client and machine-to-machine tokens), work without a `checkout`, and enforce role requirements: read for reads, editor or higher for writes and updates, manager for deletes. The caller becomes the manager of any node they create. - **`diff`** — See all changes relative to the deploy branch. - **`get_session_state`** — Check the current session's status. -- **`save`** — Publish the session. `mode: "auto"` (default) opens a PR, and Mintlify merges it immediately when the deployment's publishing setting allows direct pushes and the deploy branch isn't protected. `mode: "pr"` always opens a PR and leaves it open for review. `mode: "commit"` pushes to an existing PR branch without opening a new PR. Changing the publishing setting in the dashboard requires the admin role. +- **`save`** — Publish the session. `mode: "auto"` (default) opens a PR, and Mintlify merges it immediately when the project's publishing setting allows direct pushes and the deploy branch isn't protected. `mode: "pr"` always opens a PR and leaves it open for review. `mode: "commit"` pushes to an existing PR branch without opening a new PR. Changing the publishing setting in the dashboard requires the admin role. - **`discard_session`** — Drop all in-session changes. Keep each session focused on one change. Smaller sessions produce easier-to-review PRs. Open the `editorUrl` to watch changes render live. diff --git a/agent-context/context/skills/mintlify/reference/cli.md b/agent-context/context/skills/mintlify/reference/cli.md index 552f65d404..f1b803b261 100644 --- a/agent-context/context/skills/mintlify/reference/cli.md +++ b/agent-context/context/skills/mintlify/reference/cli.md @@ -34,7 +34,7 @@ Available on all commands. - `mint logout` — Log out of your account. - `mint status` — Show current authentication status (CLI version, email, org, subdomain). - `mint signup [flags]` — Create a new Mintlify account from the terminal. Flags: `--firstName`, `--lastName`, `--company`, `--email`; omit any to enter it interactively. Waits until you click the emailed verification link before it logs you in — run as a background process in scripts. -- `mint add-domain [--basePath ]` — Add a custom domain to the current deployment. Requires `mint login`. Pass `--basePath` to serve the documentation from a subpath such as `/docs`. +- `mint add-domain [--basePath ]` — Add a custom domain to the current project. Requires `mint login`. Pass `--basePath` to serve the documentation from a subpath such as `/docs`. ## Analytics diff --git a/agent-context/context/skills/mintlify/reference/configuration.md b/agent-context/context/skills/mintlify/reference/configuration.md index 63bd3cbbed..02f5bf2b72 100644 --- a/agent-context/context/skills/mintlify/reference/configuration.md +++ b/agent-context/context/skills/mintlify/reference/configuration.md @@ -8,7 +8,7 @@ The `docs.json` file controls the entire site. Required fields: `theme`, `name`, ### Splitting configuration with `$ref` -Use `$ref` at any level of `docs.json` to load configuration from another JSON file. Useful for splitting large configs or sharing navigation across deployments. +Use `$ref` at any level of `docs.json` to load configuration from another JSON file. Useful for splitting large configs or sharing navigation across projects. ```json { @@ -372,7 +372,7 @@ The current API version is {{apiVersion}}. Shows "Last modified on [date]" on all pages. Override per-page with `timestamp` frontmatter. -Date precedence: (1) the page's `lastUpdatedDate` frontmatter, (2) the date of the last Git commit that modified the page (GitHub/GitLab deployments), (3) the most recent deployment timestamp. Set `lastUpdatedDate` when Git history doesn't reflect when content changed (e.g., imported or synced content). +Date precedence: (1) the page's `lastUpdatedDate` frontmatter, (2) the date of the last Git commit that modified the page (GitHub/GitLab projects), (3) the most recent deployment timestamp. Set `lastUpdatedDate` when Git history doesn't reflect when content changed (e.g., imported or synced content). ## Interaction diff --git a/agent-context/context/skills/mintlify/reference/navigation.md b/agent-context/context/skills/mintlify/reference/navigation.md index 481df87b27..20d930a668 100644 --- a/agent-context/context/skills/mintlify/reference/navigation.md +++ b/agent-context/context/skills/mintlify/reference/navigation.md @@ -307,7 +307,7 @@ Version properties: Each language entry can include its own `banner`, `footer`, and `navbar` configuration overrides. -To redirect visitors from the site root to the language matching their browser's `Accept-Language` header, enable **Auto-route to preferred language** on the dashboard Add-ons page (`https://app.mintlify.com/settings/project/addons`). Mintlify only redirects visits to the site root. If a visitor picks a language with the language switcher, Mintlify remembers their choice and stops auto-routing them. If no published language matches the visitor's browser preferences, Mintlify serves the default language. +To redirect visitors from the site root to the language matching their browser's `Accept-Language` header, enable **Auto-route by language** in the **Language routing** section of the dashboard General settings page (`https://app.mintlify.com/settings/project/general`). Mintlify only redirects visits to the site root. If a visitor picks a language with the language switcher, Mintlify remembers their choice and stops auto-routing them. If no published language matches the visitor's browser preferences, Mintlify serves the default language. ## OpenAPI in navigation diff --git a/agent/index.mdx b/agent/index.mdx index 8d252c5b74..658d4bf259 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -39,12 +39,12 @@ By default, the agent opens pull requests attributed to the Mintlify bot. To att ## Choose how the agent publishes changes -By default, the agent opens a pull request for every change so your team can review it before it ships. If Mintlify hosts your deployment, the agent commits changes directly to your deployment branch so changes publish immediately. +By default, the agent opens a pull request for every change so your team can review it before it ships. If Mintlify hosts your project, the agent commits changes directly to your deployment branch so changes publish immediately. -For deployments connected to your own Git provider, click **Configure Slack** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard, then set **Review process** in Slack settings: +For projects connected to your own Git provider, click **Configure Slack** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard, then set **Review process** in Slack settings: - **Create a pull request**: The agent commits to a new branch and opens a pull request against your deploy branch. Use this option when you want a human to review changes before they publish. -- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging deployment. +- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging project. If your deploy branch has branch protection rules that block direct pushes, the agent opens a pull request even if you set **Review process** to **Push to main**. @@ -62,7 +62,7 @@ The agent can only access repositories that you connect through the Mintlify Git If your Git provider restricts access with an IP allowlist, Mintlify can route Git requests from agent sandboxes through a static IP address. -Contact Mintlify about the deployment that you want to enable static agent egress for. Once enabled, the static address applies to Git operations from the agent and automations, including cloning, fetching, and pushing connected repositories. +Contact Mintlify about the project that you want to enable static agent egress for. Once enabled, the static address applies to Git operations from the agent and automations, including cloning, fetching, and pushing connected repositories. Static agent egress applies only to Git requests from agent sandboxes. Other outbound requests do not use this static IP address. diff --git a/agent/slack.mdx b/agent/slack.mdx index 3ff92e059d..7926adade7 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -19,7 +19,7 @@ Use the agent in Slack to update your content, ask questions, and capture team k Each Slack workspace can connect to only one Mintlify organization at a time. If you try to install the agent into a workspace that is already connected to a different organization, the installation fails with a "wrong organization" error. Uninstall the app from the other organization first, or use a different Slack workspace. - You can install the Slack agent even if you don't have a Mintlify-hosted deployment. The agent still works for question answering and conversations. Features that open pull requests require a connected repository. + You can install the Slack agent even if you don't have a Mintlify-hosted project. The agent still works for question answering and conversations. Features that open pull requests require a connected repository. 1. Navigate to the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. @@ -37,7 +37,7 @@ Use the agent in Slack to update your content, ask questions, and capture team k - The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) deployments. + The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) projects. If your Git provider is behind an IP allowlist, allow the Mintlify egress IP `54.242.90.151` so the agent can clone your repository. Contact support to opt in. @@ -61,15 +61,15 @@ To reauthorize the agent, reinstall the app from your Mintlify dashboard. Reauth When you reinstall the agent into a workspace that is already connected to your organization, Mintlify refreshes the stored bot token in place. Your existing channels and threads remain intact. -If your organization has multiple deployments, the agent asks you to select which deployment to work with the first time you send a request. +If your organization has multiple projects, the agent asks you to select which project to work with the first time you send a request. -Your preferred deployment is personal to your Slack account and does not affect -other team members. You can switch to a different deployment at any time during a -conversation by clicking the **Switch deployment** button on the agent's status +Your preferred project is personal to your Slack account and does not affect +other team members. You can switch to a different project at any time during a +conversation by clicking **Switch** next to the project name on the agent's status message in the thread. The agent retains your conversation history so you can -continue where you left off with the new deployment. +continue where you left off with the new project. -You can also share a link to a pull request in any connected deployment. The agent switches to that deployment automatically and continues the PR. +You can also share a link to a pull request in any connected project. The agent switches to that project automatically and continues the PR. ## Use the agent in Slack diff --git a/ai/bring-your-own-model.mdx b/ai/bring-your-own-model.mdx index bb148f2a38..c80089477a 100644 --- a/ai/bring-your-own-model.mdx +++ b/ai/bring-your-own-model.mdx @@ -10,9 +10,9 @@ keywords: ["BYOK", "key", "OpenRouter", "Anthropic", "OpenAI", "LLM", "API key", By default, Mintlify selects the models that power the assistant and agent. To use a specific model with your own provider account, supply an API key and choose the model. Mintlify then runs inference against your provider. -One configuration covers every AI product on a deployment: the [assistant](/assistant), [agent](/agent), and [automations](/automations/index). +One configuration covers every AI product on a project: the [assistant](/assistant), [agent](/agent), and [automations](/automations/index). -Bring your own model applies to a single deployment, not to your whole organization. If your organization has more than one deployment, configure each one separately. Deployments you don't configure use Mintlify's default models. +Bring your own model applies to a single project, not to your whole organization. If your organization has more than one project, configure each one separately. Projects you don't configure use Mintlify's default models. ## Supported providers @@ -28,7 +28,7 @@ Each provider supports a fixed set of models. [Editors and admins](/dashboard/roles) can configure the model. -1. Select the deployment you want to configure. +1. Select the project you want to configure. 2. Navigate to the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard. 3. In the **AI model** section, enable **Bring your own model**. 4. Select a provider. For an OpenAI-compatible provider, enter a provider name and base URL. The base URL must use HTTPS and point to a publicly reachable host. @@ -40,14 +40,14 @@ Mintlify stores your key encrypted and never displays it again after you save it ## How credits work -AI usage on a deployment with bring your own model enabled does not consume Mintlify [credits](/credits). Your provider bills you directly for inference, and those charges do not appear in your Mintlify usage. Set any spending limits with your provider. +AI usage on a project with bring your own model enabled does not consume Mintlify [credits](/credits). Your provider bills you directly for inference, and those charges do not appear in your Mintlify usage. Set any spending limits with your provider. -Credits pool at the organization level. Other deployments in the same organization still draw from that shared balance at the standard rate for their AI usage. +Credits pool at the organization level. Other projects in the same organization still draw from that shared balance at the standard rate for their AI usage. ## Rotate or remove your key -Mintlify reuses your saved key across models for the same provider on that deployment. Enter a key again only when you rotate it, switch providers, or configure another deployment. +Mintlify reuses your saved key across models for the same provider on that project. Enter a key again only when you rotate it, switch providers, or configure another project. To rotate your key, enter the new key in the **API key** field, then click **Save**. -To stop using your own model, disable **Bring your own model**. Mintlify deletes the stored configuration and key for that deployment, and its AI products return to Mintlify's default models. AI usage on the deployment then consumes credits at the standard rate. Other deployments keep their own configurations. +To stop using your own model, disable **Bring your own model**. Mintlify deletes the stored configuration and key for that project, and its AI products return to Mintlify's default models. AI usage on the project then consumes credits at the standard rate. Other projects keep their own configurations. diff --git a/ai/contextual-menu.mdx b/ai/contextual-menu.mdx index c2c32d2792..e993693060 100644 --- a/ai/contextual-menu.mdx +++ b/ai/contextual-menu.mdx @@ -35,7 +35,7 @@ The contextual menu includes several pre-built options that you can enable by ad | **Connect to Cursor** | `cursor` | Installs your hosted MCP server in Cursor | | **Connect to VS Code** | `vscode` | Installs your hosted MCP server in VS Code | | **Connect to Devin** | `devin-mcp` | Installs your hosted MCP server in Devin | -| **Download API spec** | `download-spec` | Downloads your deployment's OpenAPI spec. If there are multiple specs, downloads them as a zip archive. Only appears on API reference pages. | +| **Download API spec** | `download-spec` | Downloads your project's OpenAPI spec. If there are multiple specs, downloads them as a zip archive. Only appears on API reference pages. | | **Custom options** | Object | Add custom options to the contextual menu | ## Enable the contextual menu diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index 5a812e8a57..eb13d4fccd 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -9,10 +9,10 @@ keywords: ["MCP", "write access", "AI", "editing", "Claude", "ChatGPT", "Cursor" The admin MCP server gives AI tools write access to your Mintlify content and settings. Use it to update content and access your dashboard. With the admin MCP, you can use your preferred AI tools to edit pages, restructure navigation, update `docs.json`, open pull requests, change settings, create workflows, and more. -Connect an MCP client such as Claude, Claude Code, ChatGPT, or Cursor to the admin MCP server. Use it to collaborate on your Mintlify content and settings with the same tools you use to write code. Content edits happen on a branch and ship through a pull request or commit when you call `save`. [Deployment management](#deployment-management) changes, such as workflow and settings updates, apply immediately to the live deployment. If your organization has multiple deployments, a single admin MCP connection can access and switch between all of them. +Connect an MCP client such as Claude, Claude Code, ChatGPT, or Cursor to the admin MCP server. Use it to collaborate on your Mintlify content and settings with the same tools you use to write code. Content edits happen on a branch and ship through a pull request or commit when you call `save`. [Project management](#project-management) changes, such as workflow and settings updates, apply immediately to the live project. If your organization has multiple projects, a single admin MCP connection can access and switch between all of them. - The admin MCP server allows AI tools to access your Mintlify dashboard. Treat it as a tool with write access. Connect it only from trusted AI tools, review every pull request before merging, and be aware that deployment management changes apply immediately without a pull request. + The admin MCP server allows AI tools to access your Mintlify dashboard. Treat it as a tool with write access. Connect it only from trusted AI tools, review every pull request before merging, and be aware that project management changes apply immediately without a pull request. The admin MCP is a hosted Mintlify service at `https://mcp.mintlify.com`. Every client connects to the same endpoint and authenticates with your Mintlify account. @@ -38,7 +38,7 @@ Before connecting the admin MCP, confirm the following: ## Connect to the admin MCP -You must have an interactive OAuth login against your Mintlify account to connect to the admin MCP. AI tools exchange that login for a session token scoped to one or more deployments, depending on how you grant access. A connection scoped to specific deployments can only check out those deployments. An organization-wide connection can check out any deployment in your organization. +You must have an interactive OAuth login against your Mintlify account to connect to the admin MCP. AI tools exchange that login for a session token scoped to one or more projects, depending on how you grant access. A connection scoped to specific projects can only check out those projects. An organization-wide connection can check out any project in your organization. @@ -104,13 +104,13 @@ You must have an interactive OAuth login against your Mintlify account to connec Every admin MCP session binds to a single Git branch. The flow is: - - If your connection has access to more than one deployment, call `list_deployments` to see which `subdomain` values you can check out. Skip this step if your connection covers only a single deployment. + + If your connection has access to more than one project, call `list_deployments` to see which `subdomain` values you can check out. Skip this step if your connection covers only a single project. - The first required call is `checkout {subdomain}`. It creates a fresh `admin-mcp/-` branch from that deployment's deploy branch (or attaches to an existing branch you name) and returns an `editorUrl` you can open to follow along in the dashboard editor. + The first required call is `checkout {subdomain}`. It creates a fresh `admin-mcp/-` branch from that project's deploy branch (or attaches to an existing branch you name) and returns an `editorUrl` you can open to follow along in the dashboard editor. - Call `list_branches` before `checkout` if you need to discover or filter existing branches in a deployment's repository. + Call `list_branches` before `checkout` if you need to discover or filter existing branches in a project's repository. The AI uses tools like `search`, `read`, `list_nodes`, `edit_page`, `write_page`, `create_node`, and `update_config` to make changes. All edits buffer on the session branch in real time—nothing touches your deploy branch yet. @@ -119,7 +119,7 @@ Every admin MCP session binds to a single Git branch. The flow is: Call `diff` at any time to see exactly what changed since your deploy branch. Open the `editorUrl` in your dashboard to see the same changes rendered. - Call `save` to flush the branch to Git. `mode: "auto"` (default) opens a pull request. If the deployment's agent review setting is push-to-main and the deploy branch isn't protected, Mintlify merges the pull request immediately (the response includes `merged: true`). Use `mode: "pr"` to always open a pull request and leave it open for review. Use `mode: "commit"` to push directly to an existing PR branch without opening a new PR. + Call `save` to flush the branch to Git. `mode: "auto"` (default) opens a pull request. If the project's agent review setting is push-to-main and the deploy branch isn't protected, Mintlify merges the pull request immediately (the response includes `merged: true`). Use `mode: "pr"` to always open a pull request and leave it open for review. Use `mode: "commit"` to push directly to an existing PR branch without opening a new PR. Call `discard_session` to drop all in-session changes and release the branch. @@ -127,7 +127,7 @@ Every admin MCP session binds to a single Git branch. The flow is: - If your connection has access to multiple deployments, each checked-out deployment keeps its own session and branch in memory at the same time. + If your connection has access to multiple projects, each checked-out project keeps its own session and branch in memory at the same time. Calling `checkout` again with a different `subdomain` or branch switches which session is active. It doesn't discard the others. To abandon an in-progress draft instead of switching away from it, call `discard_session`. @@ -141,7 +141,7 @@ This toggle shares the same `agentReviewProcess` setting as the Slack and dashbo The toggle is disabled in three cases: - **Your deploy branch requires a pull request.** If branch protection rules or required approvals prevent direct pushes, MCP changes always open a pull request regardless of this setting. -- **Mintlify hosts your deployment.** For Mintlify-hosted sites, MCP changes always push directly, unless branch protection still requires a pull request. +- **Mintlify hosts your project.** For Mintlify-hosted sites, MCP changes always push directly, unless branch protection still requires a pull request. - **You aren't an admin.** Changing this setting requires the [admin role](/dashboard/roles) on your project. Editors and viewers see the toggle disabled with a permission banner. You can also override the setting on a per-call basis by passing an explicit `mode` to `save`: `"pr"` always opens a pull request, and `"commit"` pushes to an existing PR branch without opening a new PR. @@ -167,25 +167,25 @@ You can also override the setting on a per-call basis by passing an explicit `mo - **`update_config`**: Modify `docs.json` (theme, navigation roots, integrations, SEO settings). -### Deployment management +### Project management -Code mode handles deployment-level operations that have no dedicated tool, such as managing workflows, deployment settings, members, billing, integrations, analytics, and [private page](/editor/pages#private-pages) sharing. Code mode tools don't require a `checkout`. +Code mode handles project-level operations that have no dedicated tool, such as managing workflows, project settings, members, billing, integrations, analytics, and [private page](/editor/pages#private-pages) sharing. Code mode tools don't require a `checkout`. -- **`search_code_operations`**: Search the deployment management methods available to code mode. Each result includes the method's full input schema. -- **`execute_code`**: Run a TypeScript script against the deployment management methods. The connection's granted scopes gate every method, and any method you weren't granted returns an authorization error. +- **`search_code_operations`**: Search the project management methods available to code mode. Each result includes the method's full input schema. +- **`execute_code`**: Run a TypeScript script against the project management methods. The connection's granted scopes gate every method, and any method you weren't granted returns an authorization error. - Code mode writes apply immediately to the live deployment. They don't create a branch or open a pull request. Confirm the intended change before prompting an AI tool to update workflows, settings, members, billing, or integrations. + Code mode writes apply immediately to the live project. They don't create a branch or open a pull request. Confirm the intended change before prompting an AI tool to update workflows, settings, members, billing, or integrations. ### Session -- **`list_deployments`**: List the deployments your connection can access, returning each `{subdomain, name}`. Call this to discover which `subdomain` to pass to `checkout`. -- **`checkout`**: Bind a session to a branch for a given deployment `subdomain`, or switch which deployment's session is active. -- **`list_branches`**: List Git branches available for a deployment's project, with optional `query` filtering. Returns the branch names, total count, and the deploy branch. Call this before `checkout` to attach to an existing branch by name. +- **`list_deployments`**: List the projects your connection can access, returning each `{subdomain, name}`. Call this to discover which `subdomain` to pass to `checkout`. +- **`checkout`**: Bind a session to a branch for a given project `subdomain`, or switch which project's session is active. +- **`list_branches`**: List Git branches available for a project's repository, with optional `query` filtering. Returns the branch names, total count, and the deploy branch. Call this before `checkout` to attach to an existing branch by name. - **`get_session_state`**: Inspect the current branch, edited files, and pending nav diff. - **`diff`**: List all changes between the session and your deploy branch. -- **`save`**: Open a pull request or commit to the session branch. If your deployment allows the agent to push to main and you have no branch protection rules, auto-merges the PR. +- **`save`**: Open a pull request or commit to the session branch. If your project allows the agent to push to main and you have no branch protection rules, auto-merges the PR. - **`discard_session`**: Drop the session and its in-flight changes. ## Example prompts diff --git a/analytics/streaming.mdx b/analytics/streaming.mdx index 24155eab44..dd6aebe05f 100644 --- a/analytics/streaming.mdx +++ b/analytics/streaming.mdx @@ -1,7 +1,7 @@ --- title: "Stream analytics events to Amazon S3" sidebarTitle: "Stream events" -description: "Configure Enterprise analytics streaming to send selected event categories from your Mintlify deployments to Amazon S3 in near real time." +description: "Configure Enterprise analytics streaming to send selected event categories from your Mintlify projects to Amazon S3 in near real time." keywords: ["analytics", "streaming", "Amazon S3", "data warehouse", "events", "Enterprise"] --- @@ -12,7 +12,7 @@ keywords: ["analytics", "streaming", "Amazon S3", "data warehouse", "events", "E Stream analytics events to Amazon S3 in near real time to send events to your data warehouse or downstream analytics pipelines without waiting for CSV exports. -Organization admins can add multiple destinations, select which event categories to send, and select which deployments to stream from. Analytics streaming uses an inclusion model: no events stream until you select at least one category and one deployment. The same category and deployment selections apply to every destination. +Organization admins can add multiple destinations, select which event categories to send, and select which projects to stream from. Analytics streaming uses an inclusion model: no events stream until you select at least one category and one project. The same category and project selections apply to every destination. ## Add a destination @@ -63,16 +63,16 @@ To stop streaming to a destination, open the streaming configuration, click the 4. Click **Save**. -## Select streamed deployments +## Select streamed projects -Select which of your organization's deployments send events. The dashboard lists each deployment by subdomain. If you create a deployment, return to the streaming configuration and select it. New deployments do not automatically start streaming events. +Select which of your organization's projects send events. The dashboard lists each project by subdomain. If you create a project, return to the streaming configuration and select it. New projects do not automatically start streaming events. 1. Navigate to the [Streaming](https://app.mintlify.com/settings/organization/streaming) page of your dashboard. 2. In the **Stream configuration** section, click **Configure**. -3. In the deployments table, select the deployments that you want to send events from. +3. In the **Projects** table, select the projects that you want to send events from. 4. Click **Save**. -No events stream until you select at least one category and one deployment. +No events stream until you select at least one category and one project. ## Understand streamed data @@ -107,7 +107,7 @@ The event payload contains the following fields: | Field | Description | | --- | --- | | `event_id` | UUID that identifies the event. Use it as a deduplication key when loading data. | -| `subdomain` | Subdomain of the deployment that generated the event. | +| `subdomain` | Subdomain of the project that generated the event. | | `user_id` | ID of the authenticated user, when available. | | `anon_id` | Anonymous visitor ID, when available. | | `session_id` | Visitor or assistant session ID, when available. | diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index ec82ae66bc..a1978a6f9f 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -304,7 +304,7 @@ Opt into a "Download API spec" entry in the [page context menu](/organize/settin } ``` -When enabled, clicking the option downloads your OpenAPI spec directly. Deployments with multiple specs receive them bundled as `api-specs.zip`. On deployments behind `auth` or `userAuth`, only authenticated readers can download the spec. +When enabled, clicking the option downloads your OpenAPI spec directly. Projects with multiple specs receive them bundled as `api-specs.zip`. On projects behind `auth` or `userAuth`, only authenticated readers can download the spec. The downloaded OpenAPI spec is unfiltered and does not respect [authentication groups](/deploy/authentication-setup). Any authenticated reader who can open the contextual menu receives the full spec, including endpoints and schemas that would otherwise be hidden from their group. Do not enable `download-spec` on an authenticated site if your OpenAPI spec contains endpoints or fields you consider sensitive. diff --git a/api/introduction.mdx b/api/introduction.mdx index f7f5b4c261..999d73c473 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -46,7 +46,7 @@ The Mintlify REST (Representational State Transfer) API enables you to programma ## Authentication -Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin and Index API keys belong to an organization. You can use the same keys across multiple deployments within the same organization. Assistant API keys belong to the deployment where you create them. +Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin and Index API keys belong to an organization. You can use the same keys across multiple projects within the same organization. Assistant API keys belong to the project where you create them. You can create up to 10 API keys per hour per organization. diff --git a/api/static-export/overview.mdx b/api/static-export/overview.mdx index 08f5dc93a5..f8f428d132 100644 --- a/api/static-export/overview.mdx +++ b/api/static-export/overview.mdx @@ -26,7 +26,7 @@ A static export runs as an asynchronous job. You start the job for a project, th Call [Start static export job](/api/static-export/start-job) with your project ID. The API queues the job and returns a `jobId`. - A deployment can have only one active job at a time. If a job is already `queued` or `running` for the deployment, the endpoint returns `409`. The endpoint is rate-limited to 10 job starts per organization per hour. + A project can have only one active job at a time. If a job is already `queued` or `running` for the project, the endpoint returns `409`. The endpoint is rate-limited to 10 job starts per organization per hour. Poll [Get static export job status](/api/static-export/get-job-status) with the `jobId` until `status` is `completed`. The completed response includes `bundleUrl`, a time-limited presigned S3 link to the bundle, along with `sizeBytes` and an `expiresAt` timestamp. diff --git a/assistant/configure.mdx b/assistant/configure.mdx index 5bf773fc24..8100303a1b 100644 --- a/assistant/configure.mdx +++ b/assistant/configure.mdx @@ -101,7 +101,7 @@ On Enterprise plans, you can [bring your own model](/ai/bring-your-own-model) to ### Allow overages -Your organization shares credits across deployments. By default, Mintlify disables overages. You can configure different overage limits for each deployment. If you disable overages for a deployment, the assistant becomes unavailable if you spend your organization's shared credit balance. The assistant remains unavailable until your credit balance resets. +Your organization shares credits across projects. By default, Mintlify disables overages. You can configure different overage limits for each project. If you disable overages for a project, the assistant becomes unavailable if you spend your organization's shared credit balance. The assistant remains unavailable until your credit balance resets. To allow overages, enable them in the **Spending controls** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard. If you enable overages, each credit spent beyond the shared balance incurs an overage charge. diff --git a/assistant/index.mdx b/assistant/index.mdx index a9df441a7d..77adc7f81c 100644 --- a/assistant/index.mdx +++ b/assistant/index.mdx @@ -6,7 +6,7 @@ boost: 3 --- - The assistant is available on the [Pro plan and above](https://mintlify.com/pricing?ref=assistant). Every Pro plan contributes 10,000 credits per month to your organization's shared credit balance, used across the assistant, agent, and automations on every deployment. See [Manage billing](/assistant/configure#manage-billing) for more information about credit tiers and options. + The assistant is available on the [Pro plan and above](https://mintlify.com/pricing?ref=assistant). Every Pro plan contributes 10,000 credits per month to your organization's shared credit balance, used across the assistant, agent, and automations on every project. See [Manage billing](/assistant/configure#manage-billing) for more information about credit tiers and options. ## About the assistant diff --git a/assistant/narration.mdx b/assistant/narration.mdx index 5cb9be5406..f47635f6d1 100644 --- a/assistant/narration.mdx +++ b/assistant/narration.mdx @@ -13,7 +13,7 @@ Narration adds a **Listen to this page** player at the top of each page. When a Mintlify generates narration on demand from your published content, so audio always matches the content of the page. When a page changes, the next listener triggers a fresh generation. -The **Listen to this page** player only appears on pages with narratable content. Very short pages and pages that are mostly non-prose cannot be narrated. Narration is not available for deployments that require authentication to access. +The **Listen to this page** player only appears on pages with narratable content. Very short pages and pages that are mostly non-prose cannot be narrated. Narration is not available for projects that require authentication to access. Narration uses credits from your organization's shared credit balance. Each generation costs 50 credits. Replays of the same page version are free. See [Credit pricing](/credits) for details. Track usage on the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard. diff --git a/assistant/skills.mdx b/assistant/skills.mdx index 5a7e29b613..561bd9f692 100644 --- a/assistant/skills.mdx +++ b/assistant/skills.mdx @@ -69,4 +69,4 @@ Skills work alongside [custom assistant instructions](/assistant/customize) in ` ## Disable skills -Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com). +Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your project, contact [support](mailto:support@mintlify.com). diff --git a/assistant/widget.mdx b/assistant/widget.mdx index d34d50a40f..6c757e966f 100644 --- a/assistant/widget.mdx +++ b/assistant/widget.mdx @@ -23,7 +23,7 @@ The only required browser option is the public widget ID. Manage the enabled sta ## Enable the widget -1. Navigate to your deployment's [Widget](https://app.mintlify.com/settings/project/widget) page. +1. Navigate to your project's [Widget](https://app.mintlify.com/settings/project/widget) page. 2. Enable the widget. 3. Add allowed origins where you embed the widget. 4. Copy the widget ID. diff --git a/cli/commands.mdx b/cli/commands.mdx index 4986511ff1..8a12a990a6 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -157,7 +157,7 @@ mint login Opens a browser window to complete authentication. If the browser does not open, the CLI displays a URL to open manually and a prompt to paste the authorization code. Credentials save in `~/.config/mintlify/config.json`. -If you have more than one deployment, the CLI prompts you to select a default after you log in. You can change the default project later with `mint config set subdomain `. +If you have more than one project, the CLI prompts you to select a default after you log in. You can change the default project later with `mint config set subdomain `. --- @@ -183,7 +183,7 @@ mint status ## `mint add-domain` -Add a [custom domain](/customize/custom-domain) to your deployment from the terminal. Requires authentication with `mint login`. +Add a [custom domain](/customize/custom-domain) to your project from the terminal. Requires authentication with `mint login`. ```bash mint add-domain [--basePath ] @@ -209,7 +209,7 @@ CNAME @ → cname.mintlify.builders Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details. -If the command fails with `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`, the domain is bound to another Mintlify deployment. See [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization) to release it and re-add it. +If the command fails with `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`, the domain is bound to another Mintlify project. See [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization) to release it and re-add it. If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/project/custom-domain) page in your dashboard for the remaining values. diff --git a/cli/index.mdx b/cli/index.mdx index ea54fbc3bd..385ff103c6 100644 --- a/cli/index.mdx +++ b/cli/index.mdx @@ -21,7 +21,7 @@ import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally, test changes in real time, and run quality checks before deploying to production. -The CLI runs on your machine and connects to your Mintlify deployment when you need live data. +The CLI runs on your machine and connects to your Mintlify project when you need live data. When a user asks you to set up Mintlify or create a documentation site, use the CLI for the full workflow rather than giving them only manual dashboard instructions. Follow the [agent setup workflow](/quickstart#set-up-mintlify-for-the-user), which covers `mint signup`, `mint login`, `mint new`, `mint dev`, validation, and deployment verification. diff --git a/contact-support.mdx b/contact-support.mdx index d27a27f170..4929132b9c 100644 --- a/contact-support.mdx +++ b/contact-support.mdx @@ -21,4 +21,4 @@ Send us a message from your [dashboard](https://app.mintlify.com/). Click support@mintlify.com. Include the URL of your [dashboard](https://app.mintlify.com/) with your organization and deployment in your email so we can help you faster. For example, `app.mintlify.com/your-org/your-deployment`. +If you can't access your dashboard, email us at support@mintlify.com. Include the URL of your [dashboard](https://app.mintlify.com/) with your organization and project in your email so we can help you faster. For example, `app.mintlify.com/your-org/your-project`. diff --git a/credits.mdx b/credits.mdx index e10d801c2c..186934918a 100644 --- a/credits.mdx +++ b/credits.mdx @@ -4,22 +4,22 @@ description: "Learn the fixed credit price of each AI action, how your shared cr keywords: ["credits", "billing", "pricing", "organization", "assistant", "agent", "automations", "narration", "audio", "add-ons", "overages", "rollovers", "usage", "export", "CSV", "activity log"] --- -Mintlify's AI features run on credits. Every action has a fixed credit price, and you pay only when an action produces a result. Your organization has one monthly credit balance, shared by every deployment and everyone on your team. Manage it on the [Usage](https://app.mintlify.com/settings/organization/usage) page in your dashboard. +Mintlify's AI features run on credits. Every action has a fixed credit price, and you pay only when an action produces a result. Your organization has one monthly credit balance, shared by every project and everyone on your team. Manage it on the [Usage](https://app.mintlify.com/settings/organization/usage) page in your dashboard. ## Your shared balance Your balance comes from three places: -- **Your plans.** Every Pro plan in your organization contributes 10,000 credits per month. An organization with two Pro deployments starts each month with 20,000 credits. -- **Add-ons.** Buy an add-on when you need more than your plans include. An add-on is one purchase for the organization rather than one per deployment, and any deployment can spend it. +- **Your plans.** Every Pro plan in your organization contributes 10,000 credits per month. An organization with two Pro projects starts each month with 20,000 credits. +- **Add-ons.** Buy an add-on when you need more than your plans include. An add-on is one purchase for the organization rather than one per project, and any project can spend it. - **Rollover.** Unused credits carry into the next month and join the same balance. -Every deployment and every team member spends from that shared balance. The [Usage](https://app.mintlify.com/settings/organization/usage) page shows the organization-wide balance, with per-deployment usage broken out below it. +Every project and every team member spends from that shared balance. The [Usage](https://app.mintlify.com/settings/organization/usage) page shows the organization-wide balance, with per-project usage broken out below it. -Individual deployments have their own overage settings, so you can configure different overage behaviors for each one. +Individual projects have their own overage settings, so you can configure different overage behaviors for each one. - Credits were previously tracked per deployment. They now pool at the organization level. + Credits were previously tracked per project. They now pool at the organization level. ## What uses credits @@ -84,7 +84,7 @@ Each add-on adds credits to your organization's monthly balance on top of what y | 40,000 | $370 | | 90,000 | $800 | -A single Pro deployment with the 40,000-credit add-on has 50,000 credits per month. Larger add-ons cost less per credit. The 90,000-credit add-on costs about 8% less per credit than the 15,000-credit one. All three add-ons cost less per credit than the $0.01 overage rate. +A single Pro project with the 40,000-credit add-on has 50,000 credits per month. Larger add-ons cost less per credit. The 90,000-credit add-on costs about 8% less per credit than the 15,000-credit one. All three add-ons cost less per credit than the $0.01 overage rate. Add or change an add-on in the **Credit packages** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page. Changes take effect immediately, and Mintlify prorates the charges to your current billing cycle. @@ -96,15 +96,15 @@ For the most current pricing, see the [pricing page](https://mintlify.com/pricin ### Overages -Overages let a deployment keep running after your organization exhausts its monthly credits, at $0.01 per additional credit. They are off by default. Enable them in the **Spending controls** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page. +Overages let a project keep running after your organization exhausts its monthly credits, at $0.01 per additional credit. They are off by default. Enable them in the **Spending controls** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page. -You configure overages per deployment, so when the shared balance runs out, each deployment's own setting decides what happens to it. A deployment with overages off loses its credit-powered features until the balance resets. +You configure overages per project, so when the shared balance runs out, each project's own setting decides what happens to it. A project with overages off loses its credit-powered features until the balance resets. Every add-on costs less per credit than the $0.01 overage rate. Use overages to absorb an occasional busy month. If your organization exceeds its balance consistently, buy an add-on or move to a larger one instead. ### Usage alerts -Set usage alerts in the **Spending controls** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page to receive an email when your organization reaches a given percentage of its balance. Alerts cover the organization as a whole rather than a single deployment. +Set usage alerts in the **Spending controls** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page to receive an email when your organization reaches a given percentage of its balance. Alerts cover the organization as a whole rather than a single project. ### Rollovers diff --git a/customize/custom-domain.mdx b/customize/custom-domain.mdx index 2e8513e9e2..4a0ddb58fc 100644 --- a/customize/custom-domain.mdx +++ b/customize/custom-domain.mdx @@ -38,7 +38,7 @@ If your domain traffic routes to Mintlify, the dashboard displays the DNS record If you proxy only your subpath to Mintlify, the dashboard displays reverse proxy setup guides instead. Follow the guide for your provider and see [Host docs at a subpath](/deploy/docs-subpath) for more information. - You can also add a domain from the terminal with [`mint add-domain `](/cli/commands#mint-add-domain). The command registers the domain on your deployment and prints the DNS records to configure. + You can also add a domain from the terminal with [`mint add-domain `](/cli/commands#mint-add-domain). The command registers the domain on your project and prints the DNS records to configure. ### Base path requirements @@ -144,7 +144,7 @@ Only retry validation after you confirm that your DNS records are correct. Repea To remove a custom domain, click the remove icon next to your domain on the [Custom domain setup](https://app.mintlify.com/settings/project/custom-domain) page and confirm the removal. Existing links to the domain may break, and re-adding the domain may require reconfiguring your DNS records. -Removing a domain also releases it so another Mintlify deployment or organization can claim it. If you cannot add a domain because another deployment holds it, see [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization). +Removing a domain also releases it so another Mintlify project or organization can claim it. If you cannot add a domain because another project holds it, see [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization). ## Set a canonical URL diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx index 1f6da6b07a..b62672d799 100644 --- a/dashboard/audit-logs.mdx +++ b/dashboard/audit-logs.mdx @@ -44,7 +44,7 @@ Filter audit logs to find specific activities. |------------------|--------------------------------------------------------------------| | Organization | Organization settings updates and deletion requests. | | Member | Team member invitations, removals, role changes, and credential revocations. | -| Deployment | Deployment configuration changes including custom domains, authentication, Git sources, MCP client credentials, rollbacks, and build promotions. | +| Project | Project configuration changes including custom domains, authentication, Git sources, MCP client credentials, rollbacks, and build promotions. | | Preview deployment | Preview deployment creation, updates, and authentication changes. | | API key | API key and discovery API key creation and deletion. | | Assistant | Assistant setting updates like deflection email, web search sites, and starter questions. | diff --git a/deploy/bitbucket.mdx b/deploy/bitbucket.mdx index d3a2cad966..52d99dd6a5 100644 --- a/deploy/bitbucket.mdx +++ b/deploy/bitbucket.mdx @@ -67,9 +67,9 @@ Revoking a connection removes the Mintlify webhooks for every repository connect ## Configure multiple repositories -You can combine content from multiple Bitbucket repositories in one site. Every source in the deployment must use Bitbucket, and you must enable each repository under **Bitbucket OAuth** before you add it as a source. +You can combine content from multiple Bitbucket repositories in one site. Every source in the project must use Bitbucket, and you must enable each repository under **Bitbucket OAuth** before you add it as a source. -See [Multi-repository deployments](/deploy/multi-repo) for setup instructions and information about URL paths, base sources, and navigation. +See [Multi-repository projects](/deploy/multi-repo) for setup instructions and information about URL paths, base sources, and navigation. ## Troubleshooting diff --git a/deploy/ci.mdx b/deploy/ci.mdx index 037df10222..b9979bc24b 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -16,7 +16,7 @@ To begin, follow the steps on the [GitHub](/deploy/github) page. ## Configuration -Configure the CI checks enabled for a deployment by navigating to the [General](https://app.mintlify.com/settings/project/general) page of your dashboard. Enable the checks that you want to run. +Configure the CI checks enabled for a project by navigating to the [General](https://app.mintlify.com/settings/project/general) page of your dashboard. Enable the checks that you want to run. When enabling checks, you can choose to run them at a `Warning` or `Blocking` level. @@ -39,7 +39,7 @@ Mintlify supports automatically running Vale in a CI check and displaying the re #### Configuration -If you have a `.vale.ini` file in the root content directory of your deployment, the Vale CI check uses that configuration file and any configuration files in your specified `StylesPath`. +If you have a `.vale.ini` file in the root content directory of your project, the Vale CI check uses that configuration file and any configuration files in your specified `StylesPath`. If you don't have a Vale config file, the default configuration automatically loads. diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index c188e8a0a2..95cff57b7e 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -1,7 +1,7 @@ --- title: "Deployments" -description: "Manage documentation deployments in the Mintlify dashboard, including viewing deployment history, monitoring build status, and troubleshooting." -keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] +description: "Manage documentation deployments in the Mintlify dashboard, including viewing deployment history, monitoring build status, troubleshooting, and deleting a project." +keywords: ["manual deployment", "deployment history", "deployment triggers", "delete project", "delete deployment"] boost: 3 --- @@ -34,26 +34,23 @@ Navigate to the [activity](https://app.mintlify.com/activity) page in your dashb If a change reaches your live site that you must remove immediately, serve a previous successful build instead of reverting commits and waiting for a new build. See [Rollbacks](/deploy/rollbacks). -## Delete a deployment +## Delete a project -You can permanently delete a deployment from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page in your dashboard. This action is irreversible and removes all deployment data, including any associated preview deployments. +You can permanently delete a project from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page in your dashboard. This action is irreversible and removes all project data, including any associated preview deployments. Go to the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page in your dashboard. - -{/* vale Mintlify.FirstPerson = NO */} - - 1. In the **Delete my deployment** section, provide a reason for deletion. - 2. Click the delete button and confirm that you want to delete the deployment. - -{/* vale Mintlify.FirstPerson = YES */} + + 1. In the **Delete project** row, click **Delete…**. + 2. Enter a reason for deletion. + 3. Click **Delete project** to confirm. - Deleting a deployment is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period. + Deleting a project is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period. -If you have multiple deployments, Mintlify redirects you to another deployment after deletion. If you delete your only deployment, Mintlify redirects you to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion. +If you have multiple projects, Mintlify redirects you to another project after deletion. If you delete your only project, Mintlify redirects you to the Mintlify homepage. When you delete a project, the organization admin receives an email notification confirming the deletion. diff --git a/deploy/ghes.mdx b/deploy/ghes.mdx index 780eca8203..95df8b9860 100644 --- a/deploy/ghes.mdx +++ b/deploy/ghes.mdx @@ -172,10 +172,10 @@ Share the following information with our team using your secure information tran ## Mintlify connection We take the credentials you provide us and store them, encrypted, in a secure location. Then we work with you to either: -- Integrate your GHES environment with an existing Mintlify deployment. -- Integrate your GHES environment with a new Mintlify deployment that we provision for you. +- Integrate your GHES environment with an existing Mintlify project. +- Integrate your GHES environment with a new Mintlify project that we provision for you. -After you integrate your GHES environment with a Mintlify deployment, you are ready to enable webhooks for your GitHub App. +After you integrate your GHES environment with a Mintlify project, you are ready to enable webhooks for your GitHub App. The webhook URL may change based on our configuration. We test the integration and provide you with the new URL. diff --git a/deploy/gitlab-self-hosted.mdx b/deploy/gitlab-self-hosted.mdx index b56a21fb4f..f5cd51504c 100644 --- a/deploy/gitlab-self-hosted.mdx +++ b/deploy/gitlab-self-hosted.mdx @@ -11,7 +11,7 @@ You must configure OAuth authorization for self-hosted GitLab instances to suppo Unlike gitlab.com, where Mintlify ships a single OAuth application that every customer authorizes against, each self-hosted instance must register its own OAuth application. Create the application on your GitLab instance, share its credentials with Mintlify, and then go through an OAuth authorization to connect a user. - This guide is only for the **OAuth** integration that powers automations. You must configure the deployment-side connection (used for content sync and previews) separately with an access token. See the [GitLab guide](/deploy/gitlab) for instructions. The OAuth integration depends on the deployment-side connection. + This guide is only for the **OAuth** integration that powers automations. You must configure the project-side connection (used for content sync and previews) separately with an access token. See the [GitLab guide](/deploy/gitlab) for instructions. The OAuth integration depends on the project-side connection. ## Prerequisites diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index 949f72542c..11036d2212 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -69,7 +69,7 @@ To modify your GitLab connection settings after the initial setup, go to [Git Se ## Revalidate Git settings -If your deployment shows unexpected behavior, such as missing branch options or stale configuration, you can force Mintlify to refresh your Git source. +If your project shows unexpected behavior, such as missing branch options or stale configuration, you can force Mintlify to refresh your Git source. diff --git a/deploy/monorepo.mdx b/deploy/monorepo.mdx index f14219fbdf..57474ba299 100644 --- a/deploy/monorepo.mdx +++ b/deploy/monorepo.mdx @@ -7,7 +7,7 @@ keywords: ["monorepo", "content directory", "multi-project repository"] Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup lets you maintain documentation alongside your code in repositories that contain multiple projects or services. - A monorepo deployment uses a single repository with a subdirectory of docs. To combine content from more than one repository into one site, see [Multi-repository deployments](/deploy/multi-repo). + A monorepo project uses a single repository with a subdirectory of docs. To combine content from more than one repository into one site, see [Multi-repository projects](/deploy/multi-repo). A typical monorepo structure might look like this: diff --git a/deploy/multi-repo.mdx b/deploy/multi-repo.mdx index 458e85a2c2..8b8ede893e 100644 --- a/deploy/multi-repo.mdx +++ b/deploy/multi-repo.mdx @@ -1,14 +1,14 @@ --- -title: "Multi-repository deployments" +title: "Multi-repository projects" description: "Combine multiple Git repositories into one Mintlify site, with a dedicated URL path for each source repo's content and navigation." -keywords: ["multi-repo", "multiple repositories", "git sources", "URL path"] +keywords: ["multi-repo", "multiple repositories", "git sources", "URL path", "multi-repository deployments"] --- - Multi-repository deployments are available on [Enterprise plans](https://mintlify.com/pricing?ref=multi-repo). + Multi-repository projects are available on [Enterprise plans](https://mintlify.com/pricing?ref=multi-repo). -Use a multi-repository deployment when one site needs content from more than one Git repository. When you configure multiple repositories as sources for the same Mintlify project, content from each repository has its own URL path. +Use a multi-repository project when one site needs content from more than one Git repository. When you configure multiple repositories as sources for one project, content from each repository has its own URL path. For example, you can combine separate repositories for product documentation, API reference, and SDK guides into one site: @@ -18,11 +18,11 @@ docs.example.com/api docs.example.com/sdks ``` -One source in a multi-repository deployment can use a root URL path (`/`). Mintlify serves content from that source at the root of the site with no path prefix, while other sources are at their configured URL paths. Use a root URL path if one repository holds the main documentation and other repositories add sections like an API reference or SDK guides. +One source in a multi-repository project can use a root URL path (`/`). Mintlify serves content from that source at the root of the site with no path prefix, while other sources are at their configured URL paths. Use a root URL path if one repository holds the main documentation and other repositories add sections like an API reference or SDK guides. -## How multi-repository deployments work +## How multi-repository projects work -Each repository in a multi-repository deployment has its own: +Each repository in a multi-repository project has its own: - Git provider connection - Branch @@ -32,10 +32,10 @@ Each repository in a multi-repository deployment has its own: During deployment, Mintlify reads each repository and combines the configured sources into one site. Each source appears under its configured URL path. -One repository acts as the **base source** for the deployment. Its `docs.json` is the root `docs.json` and controls site-level configuration, including theme, colors, logo, site name, top-level navigation, integrations, SEO, and other top-level fields. Every other source contributes its own navigation and content under its configured URL path, plus any [variables](#variables-across-sources) that the base source doesn't define. The first repository you configure is the base source by default, and you can [change which source is the base](#change-the-base-source) at any time. +One repository acts as the **base source** for the project. Its `docs.json` is the root `docs.json` and controls site-level configuration, including theme, colors, logo, site name, top-level navigation, integrations, SEO, and other top-level fields. Every other source contributes its own navigation and content under its configured URL path, plus any [variables](#variables-across-sources) that the base source doesn't define. The first repository you configure is the base source by default, and you can [change which source is the base](#change-the-base-source) at any time. - Multi-repository deployments are different from a [monorepo setup](/deploy/monorepo). Use a monorepo setup when you store all content in a subdirectory alongside source code in a single repository. Use multi-repository deployments when you store content across separate repositories. + Multi-repository projects are different from a [monorepo setup](/deploy/monorepo). Use a monorepo setup when you store all content in a subdirectory alongside source code in a single repository. Use multi-repository projects when you store content across separate repositories. ## Requirements @@ -78,7 +78,7 @@ One repository acts as the **base source** for the deployment. Its `docs.json` i The URL path determines where the content from that repository appears on your docs site. For example, a URL path of `api` serves the content under `docs.example.com/api`. - To serve a source at the root of your site with no path prefix, leave the URL path empty or set it to `/`. Only one source per deployment can use the root URL path. + To serve a source at the root of your site with no path prefix, leave the URL path empty or set it to `/`. Only one source per project can use the root URL path. You can enter the path with or without leading slashes. Mintlify normalizes the value when you save. @@ -92,7 +92,7 @@ One repository acts as the **base source** for the deployment. Its `docs.json` i ## Change the base source -The base source provides the site-wide configuration for your multi-repository deployment. Change the base source when you want a different repository's `docs.json` to control settings like theme, colors, site name, and top-level navigation. +The base source provides the site-wide configuration for your multi-repository project. Change the base source when you want a different repository's `docs.json` to control settings like theme, colors, site name, and top-level navigation. @@ -184,7 +184,7 @@ Use `sourceRef` to place another repository's navigation at a specific location ### Requirements -- Configure the referenced repository as a source in the same multi-repository deployment. +- Configure the referenced repository as a source in the same multi-repository project. - `sourceRef` values must include at least two path segments, like `owner/repo`. Mount paths and repository names by themselves are not supported. - For GitLab repositories in nested subgroups, use the full path, like `group/subgroup/repo`. You can shorten the value to the last two segments, like `subgroup/repo`, unless two sources share the same trailing segments. When two sources share the same trailing segments, use the full path for each. - The referenced source must define a similar navigation pattern as the main source. For example, a `sourceRef` inside `anchors` requires the referenced source to define `navigation.anchors`. @@ -231,4 +231,4 @@ If `acme/api-docs` defines its own `navigation.anchors`, Mintlify replaces the ` ## Removing a repository source -You can remove a repository source from the [Git settings page](https://app.mintlify.com/settings/project/git-settings) in your dashboard. When only one repository source remains, Mintlify removes the source URL path and treats the remaining repository as the root source for the deployment. +You can remove a repository source from the [Git settings page](https://app.mintlify.com/settings/project/git-settings) in your dashboard. When only one repository source remains, Mintlify removes the source URL path and treats the remaining repository as the root source for the project. diff --git a/deploy/reverse-proxy.mdx b/deploy/reverse-proxy.mdx index fbf0dfc845..d97aab80f4 100644 --- a/deploy/reverse-proxy.mdx +++ b/deploy/reverse-proxy.mdx @@ -56,7 +56,7 @@ Mintlify serves these files under your base path, like `.mintlif The `/docs/*` route also covers generated `llms.txt` indexes under `/docs/_llms/*`. If your proxy uses a more granular path allowlist instead of forwarding all `/docs/*` requests, include `/docs/_llms/*` so agents can follow every index linked from `/docs/llms.txt`. -Do not rewrite only `/docs/llms.txt` to a root-hosted `/llms.txt`. Set `/docs` as the deployment base path and forward the full `/docs/*` route. This keeps page links and generated `/docs/_llms/*` index links on the same public prefix. +Do not rewrite only `/docs/llms.txt` to a root-hosted `/llms.txt`. Set `/docs` as the project base path and forward the full `/docs/*` route. This keeps page links and generated `/docs/_llms/*` index links on the same public prefix. The `/.well-known/skills/*`, `/.well-known/agent-skills/*`, `/skill.md`, `/llms.txt`, and `/llms-full.txt` routes are optional. Include them only if you also want to serve these files at root paths on your domain, like `your-domain.com/llms.txt`. Each root path maps to the file under your base path on your Mintlify subdomain. diff --git a/deploy/rollbacks.mdx b/deploy/rollbacks.mdx index 04bad09754..ad0fa43804 100644 --- a/deploy/rollbacks.mdx +++ b/deploy/rollbacks.mdx @@ -46,10 +46,10 @@ Both serve the most recent successful build, including any commits that landed i ## Limitations - You can roll back to any of your last 10 successful builds. -- Deployments with [authentication](/deploy/authentication-setup) enabled do not support rollbacks. +- Projects with [authentication](/deploy/authentication-setup) enabled do not support rollbacks. - You cannot roll back a preview deployment. - You cannot roll back to a build that completed before rollbacks became available. ## Review rollback history -Your [audit logs](/dashboard/audit-logs) record rollbacks and promotions under the **Deployment** category, including who performed each action and when. +Your [audit logs](/dashboard/audit-logs) record rollbacks and promotions under the **Project** category, including who performed each action and when. diff --git a/deploy/self-host.mdx b/deploy/self-host.mdx index 3bbdb5e5cc..516d69de71 100644 --- a/deploy/self-host.mdx +++ b/deploy/self-host.mdx @@ -88,7 +88,7 @@ flowchart TD | Dashboard and API | Admin, auth, and build orchestration | | | Build workers | Build and publish documentation sites | | | MongoDB | Content store | | -| PostgreSQL | Deployment and user metadata | | +| PostgreSQL | Project and user metadata | | | Redis | Build queue and caching | | | Object storage | Built site bundles and static exports | | | Search and indexing | Docs search. The index rebuilds on publish | | @@ -115,7 +115,7 @@ As a starting point, a production deployment runs on roughly 45 to 60 vCPU, 160 | --- | --- | --- | | Compute | Amazon ECS cluster | Runs the Mintlify services | | Content store | Amazon DocumentDB | MongoDB-compatible | - | Metadata store | Amazon RDS for PostgreSQL | Deployment and user metadata | + | Metadata store | Amazon RDS for PostgreSQL | Project and user metadata | | Cache and queue | Amazon ElastiCache for Redis | Build queue and caching | | Object storage | Amazon S3 | Built site bundles and static exports | | CDN | Amazon CloudFront | Serves the docs site at the edge | diff --git a/editor/agent.mdx b/editor/agent.mdx index 8cfcc2fe80..1e2cad526d 100644 --- a/editor/agent.mdx +++ b/editor/agent.mdx @@ -26,6 +26,8 @@ Example prompts: - `rename every mention of "Acme Pro" to "Acme Team" across all pages` - `update docs.json to add a new group called "Guides"` +If a missing decision would materially change the result, the agent pauses and asks you up to four questions in the chat panel. Choose a suggested option or type your own answer. + ## Attach files Click the paperclip icon in the chat box, or drag and drop files onto the panel. The agent reads attached files as context for your request. @@ -88,7 +90,7 @@ Example: `find every page that mentions the deprecated /v1/auth endpoint` ### Configure your site (code mode) -For requests that go beyond editing pages (setting up authentication, managing workflows, or changing deployment settings), the agent switches into code mode. It writes and runs a script against your Mintlify dashboard on your behalf. +For requests that go beyond editing pages (setting up authentication, managing workflows, or changing project settings), the agent switches into code mode. It writes and runs a script against your Mintlify dashboard on your behalf. Code mode respects your dashboard permissions. If you don't have access to a setting in the dashboard, the agent can't change it either. diff --git a/editor/publish.mdx b/editor/publish.mdx index 8b7b363643..eb857b0979 100644 --- a/editor/publish.mdx +++ b/editor/publish.mdx @@ -8,7 +8,7 @@ keywords: ["publish", "branch", "git", "commit", "conflicts", "deploy", "pull re Your changes save automatically as you edit, but they only reach your live site when you publish them. What happens when you publish depends on which branch you work on and whether that branch has branch protections. - If there is no **Publish** button in your editor toolbar, your deployment has [auto publish](#auto-publish) turned on and your edits go live automatically. + If there is no **Publish** button in your editor toolbar, your project has [auto publish](#auto-publish) turned on and your edits go live automatically. If there is no branch selector, [show the branch selector](#show-the-branch-selector). @@ -105,4 +105,4 @@ Sign commits with your GitHub account by authorizing it in your [account setting ## Auto publish -If your deployment has [auto publish](/editor/settings#auto-publish) turned on, the editor commits to your deployment branch shortly after you stop typing. The branch selector and **Publish** button are hidden. There is no pending state and no review step. +If your project has [auto publish](/editor/settings#auto-publish) turned on, the editor commits to your deployment branch shortly after you stop typing. The branch selector and **Publish** button are hidden. There is no pending state and no review step. diff --git a/editor/settings.mdx b/editor/settings.mdx index 2eda2a8d3f..8a6e10bb01 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -8,7 +8,7 @@ keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull reque The editor [settings page](https://app.mintlify.com/settings/project/editor) controls the appearance, publishing behavior, and agent behavior. - **Appearance**: Personal preferences for how the editor looks and behaves. These apply only to you. -- **Publishing**: Deployment-wide defaults for how the editor commits changes and opens pull requests. These apply to everyone who publishes. Only admins can update publishing behavior. +- **Publishing**: Project-wide defaults for how the editor commits changes and opens pull requests. These apply to everyone who publishes. Only admins can update publishing behavior. - **Chat**: Persistent instructions for the editor's AI agent. - **Danger zone**: Actions that can't be undone. diff --git a/help-center/agent-blocked-by-git-provider-ip-allow-list.mdx b/help-center/agent-blocked-by-git-provider-ip-allow-list.mdx index 0abe676f91..c3ccaa2c3a 100644 --- a/help-center/agent-blocked-by-git-provider-ip-allow-list.mdx +++ b/help-center/agent-blocked-by-git-provider-ip-allow-list.mdx @@ -1,6 +1,6 @@ --- title: "Fix agent runs blocked by a git provider IP allow list" -description: "Resolve agent session failures caused by a GitHub or GitLab IP allow list by routing your deployment through the Mintlify static IP." +description: "Resolve agent session failures caused by a GitHub or GitLab IP allow list by routing your project through the Mintlify static IP." keywords: ["IP allow list", "agent session failed", "static IP", "54.242.90.151", "clone failed", "GitHub allow list"] --- @@ -12,8 +12,8 @@ The agent clones and pushes to your repository from Mintlify's cloud infrastruct ## Fix the error -1. Email support@mintlify.com and ask for your deployment to be routed through the Mintlify static IP. Include your deployment subdomain. +1. Email support@mintlify.com and ask for your project to be routed through the Mintlify static IP. Include your project subdomain. 2. After Mintlify support confirms the change, add `54.242.90.151` to the IP allow list in your GitHub or GitLab organization settings. 3. Retry the agent run. -Only git traffic for your deployment is routed through the static IP. Other deployments are unaffected. +Only git traffic for your project is routed through the static IP. Other projects are unaffected. diff --git a/help-center/agent-opens-pull-requests-against-deploy-branch.mdx b/help-center/agent-opens-pull-requests-against-deploy-branch.mdx index c05f52e9d4..50dee3e329 100644 --- a/help-center/agent-opens-pull-requests-against-deploy-branch.mdx +++ b/help-center/agent-opens-pull-requests-against-deploy-branch.mdx @@ -19,11 +19,11 @@ See [Send messages to the agent](/agent/slack) for the Slack flow and [Choose ho ## Automations -Automations always open their pull requests against the deploy branch. There is no per-automation setting to target a different base branch. If you need automation output to land on a non-production branch, point the deployment itself at that branch in [Git Settings](https://app.mintlify.com/settings/project/git-settings), or use a separate deployment for that branch and run the automation there. +Automations always open their pull requests against the deploy branch. There is no per-automation setting to target a different base branch. If you need automation output to land on a non-production branch, point the project itself at that branch in [Git Settings](https://app.mintlify.com/settings/project/git-settings), or use a separate project for that branch and run the automation there. To stop automation PRs from merging without review, set the automation's update mode to **Modify and wait for review** on its configure page. See [Update mode](/automations/manage#update-mode). ## Related settings - [Choose how the agent publishes changes](/agent/index#choose-how-the-agent-publishes-changes): Pull request versus direct push, and how branch protection interacts with each. -- [Git Settings](https://app.mintlify.com/settings/project/git-settings): Change the deploy branch or the docs subdirectory the deployment builds from. +- [Git Settings](https://app.mintlify.com/settings/project/git-settings): Change the deploy branch or the docs subdirectory the project builds from. diff --git a/help-center/can-i-rename-my-deployment-or-organization.mdx b/help-center/can-i-rename-my-deployment-or-organization.mdx index f6fb5129d2..60dbda89d1 100644 --- a/help-center/can-i-rename-my-deployment-or-organization.mdx +++ b/help-center/can-i-rename-my-deployment-or-organization.mdx @@ -1,36 +1,36 @@ --- -title: "Can I rename my deployment or organization?" -description: "Rename your deployment or organization from the dashboard, and learn why subdomains and organization slugs require deleting and recreating instead." -keywords: ["rename deployment", "change deployment name", "rename organization", "change organization name", "change subdomain", "project name", "delete and recreate"] +title: "Can I rename my project or organization?" +description: "Rename your project or organization from the dashboard, and learn why subdomains and organization slugs require deleting and recreating instead." +keywords: ["rename project", "change project name", "rename deployment", "change deployment name", "rename organization", "change organization name", "change subdomain", "project name", "delete and recreate"] --- Some names in Mintlify can be changed at any time and others are fixed when they are created: -- **Changeable**: your organization's name, your deployment's name, your docs site name in `docs.json`, and your custom domain. -- **Fixed**: your deployment's subdomain and your organization's slug. Changing either requires deleting and recreating. +- **Changeable**: your organization's name, your project's name, your docs site name in `docs.json`, and your custom domain. +- **Fixed**: your project's subdomain and your organization's slug. Changing either requires deleting and recreating. -## Rename your deployment +## Rename your project -The deployment name is the display name shown in the dashboard topbar. To change it: +The project name is the display name for your project in the dashboard. To change it: 1. Go to the [General settings](https://app.mintlify.com/settings/project/general) page in your dashboard. -2. In the **Deployment name** field, enter the new name. Names must be 3 to 100 characters and contain only letters, numbers, hyphens, and underscores. +2. In the **Project name** field, enter the new name. Names must be 3 to 100 characters and contain only letters, numbers, hyphens, and underscores. 3. Save your changes. -Renaming the deployment requires permission to update the deployment. If the field is disabled, contact an admin of your organization. See [Roles and permissions](/dashboard/roles). +Renaming the project requires permission to update the project. If the field is disabled, contact an admin of your organization. See [Roles and permissions](/dashboard/roles). -## Change your deployment's subdomain +## Change your project's subdomain -Your subdomain identifies your deployment. It appears in your `.mintlify.app` URL and in your dashboard URL, `app.mintlify.com//`. The subdomain cannot be changed after the deployment is created. +Your subdomain identifies your project. It appears in your `.mintlify.app` URL and in your dashboard URL, `app.mintlify.com//`. The subdomain cannot be changed after the project is created. -To use a different subdomain, create a new deployment with the name you want, then delete the old one: +To use a different subdomain, create a new project with the name you want, then delete the old one: -1. Create a new deployment connected to the same repository. -2. If you use a custom domain, remove it from the old deployment, then add it to the new deployment. See [Custom domain](/customize/custom-domain). -3. Delete the old deployment from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page. See [Delete a deployment](/deploy/deployments#delete-a-deployment). +1. Create a new project connected to the same repository. +2. If you use a custom domain, remove it from the old project, then add it to the new project. See [Custom domain](/customize/custom-domain). +3. Delete the old project from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page. See [Delete a project](/deploy/deployments#delete-a-project). - Deleting a deployment is permanent and removes all deployment data, including analytics history and any associated preview deployments. Dashboard settings do not transfer to the new deployment, so reconfigure them after you create it. + Deleting a project is permanent and removes all project data, including analytics history and any associated preview deployments. Dashboard settings do not transfer to the new project, so reconfigure them after you create it. ## Rename your organization @@ -45,7 +45,7 @@ Renaming the organization requires permission to update the organization. If the ## Change your organization's slug -Your organization's slug is the unique identifier that appears in your dashboard URL, `app.mintlify.com//`. The slug cannot be changed after the organization is created. To use a different slug, create a new organization, recreate your deployments in it, and delete the old organization from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page. Deleting an organization is irreversible and requires the [admin role](/dashboard/roles). +Your organization's slug is the unique identifier that appears in your dashboard URL, `app.mintlify.com//`. The slug cannot be changed after the organization is created. To use a different slug, create a new organization, recreate your projects in it, and delete the old organization from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page. Deleting an organization is irreversible and requires the [admin role](/dashboard/roles). ## What your readers see diff --git a/help-center/domain-already-claimed-by-another-organization.mdx b/help-center/domain-already-claimed-by-another-organization.mdx index 17dc4be727..eb615e671f 100644 --- a/help-center/domain-already-claimed-by-another-organization.mdx +++ b/help-center/domain-already-claimed-by-another-organization.mdx @@ -1,26 +1,26 @@ --- title: "Fix \"Domain already claimed by another organization\" error" -description: "Release a custom domain from another Mintlify deployment or request help when adding it fails because another deployment or organization already holds it." -keywords: ["Domain is already in use by another deployment in your organization", "Domain is already claimed by another organization", "custom domain", "release domain", "domain ownership"] +description: "Release a custom domain from another Mintlify project or request help when adding it fails because another project or organization already holds it." +keywords: ["Domain is already in use by another deployment in your organization", "Domain is already claimed by another organization", "custom domain", "release domain", "domain ownership", "project"] --- -When you try to add a custom domain that is registered to another Mintlify deployment, the dashboard or [`mint add-domain`](/cli/commands#mint-add-domain) returns one of these errors: +When you try to add a custom domain that is registered to another Mintlify project, the dashboard or [`mint add-domain`](/cli/commands#mint-add-domain) returns one of these errors: -- `Domain is already in use by another deployment in your organization` means the domain belongs to another deployment you can access. -- `Domain is already claimed by another organization` means the domain belongs to a deployment in a different Mintlify organization. This can happen when a trial account, unused organization, or deployment created with another work email still holds the domain. +- `Domain is already in use by another deployment in your organization` means the domain belongs to another project you can access. +- `Domain is already claimed by another organization` means the domain belongs to a project in a different Mintlify organization. This can happen when a trial account, unused organization, or project created with another work email still holds the domain. -Only one deployment can hold a custom domain at a time. Release the domain from the current deployment before you add it to the destination deployment. +Only one project can hold a custom domain at a time. Release the domain from the current project before you add it to the destination project. ## Release the domain yourself If you can access the organization that holds the domain: 1. Sign in to the [dashboard](https://app.mintlify.com/) and switch to the organization that holds the domain. -2. Open the [Custom domain setup](https://app.mintlify.com/settings/project/custom-domain) page for the deployment that holds the domain. +2. Open the [Custom domain setup](https://app.mintlify.com/settings/project/custom-domain) page for the project that holds the domain. 3. Click the remove icon next to the domain and confirm the removal. 4. Switch to the destination organization and add the domain from its [Custom domain setup](https://app.mintlify.com/settings/project/custom-domain) page. -Your DNS records remain valid as long as the `CNAME` still points to `cname.mintlify.builders`. If you also want to retire the old deployment, delete it from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page. See [Delete a deployment](/deploy/deployments#delete-a-deployment). +Your DNS records remain valid as long as the `CNAME` still points to `cname.mintlify.builders`. If you also want to retire the old project, delete it from the **Danger zone** section of the [Organization](https://app.mintlify.com/settings/organization/general) settings page. See [Delete a project](/deploy/deployments#delete-a-project). ## Request a release from support @@ -29,7 +29,7 @@ If you cannot access the organization that holds the domain, email -Disable indexing when you need to keep a deployment online for internal review, staging, or limited sharing. This prevents the site from appearing in public search results and prevents AI tools from using it as training or retrieval data. +Disable indexing when you need to keep a project online for internal review, staging, or limited sharing. This prevents the site from appearing in public search results and prevents AI tools from using it as training or retrieval data. Enabling or disabling indexing redeploys your site. Changes to indexing take effect after the redeployment completes. diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 192c7d7296..9462b744d0 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -21,7 +21,7 @@ Use the pattern that matches how you want visitors to move between top-level sec | [Tabs](#tabs) | You have parallel sections that share the same audience. | Guides, API reference, and SDKs tabs for one product. | | [Anchors](#anchors) | You want persistent links to a small number of top-level destinations (external or internal) visible at all times. | Community, status page, or another link alongside your product documentation. | | [Dropdowns](#dropdowns) | Similar to tabs, but you want to use a dropdown menu for navigation. | Switching between product documentation, API reference, and partner integrations. | -| [Products](#products) | You maintain documentation for multiple distinct products under one deployment, and each product has its own full site. | A platform with separate content for Payments, Identity, and Analytics. | +| [Products](#products) | You maintain documentation for multiple distinct products under one project, and each product has its own full site. | A platform with separate content for Payments, Identity, and Analytics. | | [Versions](#versions) | You publish multiple versions of the same content in parallel. | Maintaining `v1` and `v2` API docs simultaneously. | | [Languages](#languages) | You publish translated versions of the same content. | English, Spanish, and Japanese documentation for one product. | @@ -869,7 +869,7 @@ For automated translations, [set up an automation](/automations) to run the agen If you publish in multiple languages, you can redirect visitors from the root of your site to the language that matches their browser's `Accept-Language` header. 1. Navigate to the [General](https://app.mintlify.com/settings/project/general) page in your dashboard. -2. Enable **Auto-route to preferred language**. +2. In the **Language routing** section, enable **Auto-route by language**. If a visitor selects a language with the language switcher, Mintlify remembers their choice and stops auto-routing them. If no published language matches the visitor's browser preferences, Mintlify serves your default language. diff --git a/organize/pages.mdx b/organize/pages.mdx index b288aaa776..31f20d3f6b 100644 --- a/organize/pages.mdx +++ b/organize/pages.mdx @@ -82,7 +82,7 @@ Use frontmatter to control: - A list of related pages to show in the **Related topics** section at the bottom of the page, or `false` to hide the section entirely. Overrides the deployment's automatic suggestions. Requires enabling the [Related pages](/organize/related-pages) add-on. + A list of related pages to show in the **Related topics** section at the bottom of the page, or `false` to hide the section entirely. Overrides the project's automatic suggestions. Requires enabling the [Related pages](/organize/related-pages) add-on. @@ -177,7 +177,7 @@ mode: "center" Assistant mode renders the page as a full-screen [assistant](/assistant) experience. A chat interface replaces all page content. Use this mode to create a dedicated page for users to interact with the assistant, such as an "Ask AI" page. Every theme supports assistant mode. -To use assistant mode, you must enable the [assistant](/assistant) on your deployment. If you don't enable the assistant, the assistant page mode shows a disabled search field. +To use assistant mode, you must enable the [assistant](/assistant) on your project. If you don't enable the assistant, the assistant page mode shows a disabled search field. ```yaml --- @@ -270,5 +270,5 @@ lastUpdatedDate: "2026-08-13" Mintlify determines the displayed date in the following order: 1. The `lastUpdatedDate` frontmatter field, if set on the page. -2. For deployments backed by Git, the date of the last commit that modified the page's source file. +2. For projects backed by Git, the date of the last commit that modified the page's source file. 3. The most recent deployment timestamp. diff --git a/organize/related-pages.mdx b/organize/related-pages.mdx index 98b5f89692..54d54ae1a2 100644 --- a/organize/related-pages.mdx +++ b/organize/related-pages.mdx @@ -80,4 +80,4 @@ related: false In **Automatic** mode, Mintlify generates related pages from your docs' search index using the current page's title as the query. It filters results by the page's language and version when applicable, and excludes the current page. -For deployments with [end-user authentication](/deploy/authentication-setup), Mintlify loads automatic suggestions after a reader signs in, using that reader's own authenticated search results. Related pages only include pages the reader has permission to view. For more control in an authenticated deployment, use the `related` frontmatter field to curate suggestions. +For projects with [end-user authentication](/deploy/authentication-setup), Mintlify loads automatic suggestions after a reader signs in, using that reader's own authenticated search results. Related pages only include pages the reader has permission to view. For more control in an authenticated project, use the `related` frontmatter field to curate suggestions. diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx index 51f89ade7e..8bf27388d3 100644 --- a/organize/settings-reference.mdx +++ b/organize/settings-reference.mdx @@ -707,7 +707,7 @@ Global page metadata settings. #### `metadata.timestamp` -Display a last-modified date on all pages. For deployments backed by GitHub or GitLab, the date reflects the last Git commit that touched a page's source file. It falls back to the most recent deployment timestamp if a Git commit date isn't available. +Display a last-modified date on all pages. For projects backed by GitHub or GitLab, the date reflects the last Git commit that touched a page's source file. It falls back to the most recent deployment timestamp if a Git commit date isn't available. Set the `lastUpdatedDate` frontmatter field on a page to override the automatic date. See [Pages](/organize/pages#last-modified-timestamp) for details. diff --git a/organize/settings-structure.mdx b/organize/settings-structure.mdx index f06503640b..af225e5c18 100644 --- a/organize/settings-structure.mdx +++ b/organize/settings-structure.mdx @@ -386,7 +386,7 @@ The contextual menu gives users quick access to AI tools and page actions. It ap - `"devin"`—Send the current page to Devin - `"devin-mcp"`—Install your hosted MCP server in Devin - `"download-pdf"`—Download the current page as a PDF - - `"download-spec"`—Download the deployment's OpenAPI specs (single file, or zipped if multiple) + - `"download-spec"`—Download the project's OpenAPI specs (single file, or zipped if multiple) - `"grok"`—Send the current page to Grok - `"mcp"`—Copy your MCP server URL to the clipboard - `"perplexity"`—Send the current page to Perplexity diff --git a/quickstart.mdx b/quickstart.mdx index 92da0694ad..c2fdccba37 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -61,7 +61,7 @@ When you connect your documentation repository to your project, you can work on ## Deploy your documentation site - Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your site and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments. + Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your project and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments. In the final onboarding step, describe the docs that you want to build. You can add links to your existing site, upload files, or select GitHub repositories to use as sources. The Mintlify agent generates a starting point for your docs while you watch a live preview. Answer any questions the agent asks to refine the result. To start with placeholder content instead, select **Skip, start from a blank template**. diff --git a/snippets/migration-launch-checklist.mdx b/snippets/migration-launch-checklist.mdx index fcd47cd33b..64cfed571a 100644 --- a/snippets/migration-launch-checklist.mdx +++ b/snippets/migration-launch-checklist.mdx @@ -2,7 +2,7 @@ - Set a content freeze on your former site and track every change made to it after your migration snapshot. - Confirm your production branch and repository on the [Git settings](https://app.mintlify.com/settings/project/git-settings) page of your dashboard. -- Record your existing DNS records and keep your former site running until you verify your Mintlify deployment is live. +- Record your existing DNS records and keep your former site running until you verify your Mintlify site is live. - Review the navbar, footer, favicon, logo, colors, and typography. - Review site and page metadata, canonical URLs, and indexing preferences. See [SEO and search settings](/organize/settings-seo). - Install any required [analytics integrations](/integrations/analytics/overview), and optionally add a [custom 404 page](/customize/custom-404-page). From b16eac49771e0ab4e2b62094ebbabb2339e7d7ae Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 24 Sep 2026 14:54:38 -0700 Subject: [PATCH 5/5] copyedit --- agent/index.mdx | 2 +- agent/slack.mdx | 8 ++------ deploy/gitlab-self-hosted.mdx | 2 +- deploy/multi-repo.mdx | 2 +- reference/concepts.mdx | 2 +- reference/glossary.mdx | 2 +- 6 files changed, 7 insertions(+), 11 deletions(-) diff --git a/agent/index.mdx b/agent/index.mdx index 658d4bf259..c49f5f0a62 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -44,7 +44,7 @@ By default, the agent opens a pull request for every change so your team can rev For projects connected to your own Git provider, click **Configure Slack** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard, then set **Review process** in Slack settings: - **Create a pull request**: The agent commits to a new branch and opens a pull request against your deploy branch. Use this option when you want a human to review changes before they publish. -- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging project. +- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging deployment. If your deploy branch has branch protection rules that block direct pushes, the agent opens a pull request even if you set **Review process** to **Push to main**. diff --git a/agent/slack.mdx b/agent/slack.mdx index 7926adade7..25071ab501 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -63,13 +63,9 @@ When you reinstall the agent into a workspace that is already connected to your If your organization has multiple projects, the agent asks you to select which project to work with the first time you send a request. -Your preferred project is personal to your Slack account and does not affect -other team members. You can switch to a different project at any time during a -conversation by clicking **Switch** next to the project name on the agent's status -message in the thread. The agent retains your conversation history so you can -continue where you left off with the new project. +Your preferred project is personal to your Slack account and does not affect other team members. To switch to a different project at any time during a conversation, click **Switch** next to the project name on the agent's status message in the thread. The agent retains your conversation history so you can continue where you left off in the project that you switch to. -You can also share a link to a pull request in any connected project. The agent switches to that project automatically and continues the PR. +If you share a link to a pull request in any connected project, the agent switches to that project automatically and continues the working on the branch that the pull request targets. ## Use the agent in Slack diff --git a/deploy/gitlab-self-hosted.mdx b/deploy/gitlab-self-hosted.mdx index f5cd51504c..b56a21fb4f 100644 --- a/deploy/gitlab-self-hosted.mdx +++ b/deploy/gitlab-self-hosted.mdx @@ -11,7 +11,7 @@ You must configure OAuth authorization for self-hosted GitLab instances to suppo Unlike gitlab.com, where Mintlify ships a single OAuth application that every customer authorizes against, each self-hosted instance must register its own OAuth application. Create the application on your GitLab instance, share its credentials with Mintlify, and then go through an OAuth authorization to connect a user. - This guide is only for the **OAuth** integration that powers automations. You must configure the project-side connection (used for content sync and previews) separately with an access token. See the [GitLab guide](/deploy/gitlab) for instructions. The OAuth integration depends on the project-side connection. + This guide is only for the **OAuth** integration that powers automations. You must configure the deployment-side connection (used for content sync and previews) separately with an access token. See the [GitLab guide](/deploy/gitlab) for instructions. The OAuth integration depends on the deployment-side connection. ## Prerequisites diff --git a/deploy/multi-repo.mdx b/deploy/multi-repo.mdx index 8b8ede893e..1aa49e8cb0 100644 --- a/deploy/multi-repo.mdx +++ b/deploy/multi-repo.mdx @@ -5,7 +5,7 @@ keywords: ["multi-repo", "multiple repositories", "git sources", "URL path", "mu --- - Multi-repository projects are available on [Enterprise plans](https://mintlify.com/pricing?ref=multi-repo). + Multi-repository projects require an [Enterprise plan](https://mintlify.com/pricing?ref=multi-repo). Use a multi-repository project when one site needs content from more than one Git repository. When you configure multiple repositories as sources for one project, content from each repository has its own URL path. diff --git a/reference/concepts.mdx b/reference/concepts.mdx index 113470f289..ebd81bd551 100644 --- a/reference/concepts.mdx +++ b/reference/concepts.mdx @@ -1,7 +1,7 @@ --- title: "Concepts" description: "Learn how Mintlify connects your organization, documentation repository, editing workflows, previews, deployments, analytics, and AI features." -keywords: ["concepts", "how Mintlify works", "repository", "project", "deployment", "publishing", "AI"] +keywords: ["how Mintlify works"] --- Mintlify turns content in a Git repository into a documentation site. You can work from the editor in your browser, your local development environment, or prompt the Mintlify agent in Slack. All three workflows update the same repository. Mintlify builds your repository content into optimized experiences for people and agents. diff --git a/reference/glossary.mdx b/reference/glossary.mdx index 1839fa6b36..40826150b3 100644 --- a/reference/glossary.mdx +++ b/reference/glossary.mdx @@ -1,7 +1,7 @@ --- title: "Glossary" description: "Definitions for Mintlify product, content, navigation, deployment, Git, API playground, and AI terminology used throughout the documentation." -keywords: ["glossary", "terms", "definitions", "terminology"] +keywords: ["terms", "definitions", "terminology"] --- Use this glossary as a quick reference for terms used in Mintlify and throughout this documentation. For an overview of how the parts fit together, see [Concepts](/reference/concepts).