diff --git a/admin-openapi.json b/admin-openapi.json index 3336b7288..ca41f8af0 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -580,7 +580,7 @@ "schema": { "type": "string" }, - "description": "The ID of the automation to trigger. Copy it from the automation's settings panel on the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard." + "description": "The ID of the automation to trigger. Copy it from the automation's settings panel in your [Automations](https://app.mintlify.com/settings/project/automations) settings." } ], "responses": { @@ -596,7 +596,7 @@ }, "runId": { "type": "string", - "description": "The ID of the queued automation run. Appears in the run history on the [Automations](https://app.mintlify.com/settings/project/automations) page." + "description": "The ID of the queued automation run. Appears on the **Runs** tab of your [Automations](https://app.mintlify.com/settings/project/automations?tab=runs) settings." } } } diff --git a/agent/index.mdx b/agent/index.mdx index 481237162..9c5078b7b 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -42,7 +42,7 @@ By default, the agent opens pull requests attributed to the Mintlify bot. To att 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 projects connected to your own Git provider, click **Configure Slack** on the [Automations](https://app.mintlify.com/settings/project/automations) page of your dashboard, then set **Review process** in Slack settings: +For projects connected to your own Git provider, click **Configure Slack** in your [Automations](https://app.mintlify.com/settings/project/automations) settings, 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. diff --git a/agent/slack.mdx b/agent/slack.mdx index d5c347f72..4563ca9e7 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -22,7 +22,7 @@ Use the agent in Slack to update your content, ask questions, and capture team k 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/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click **Connect Slack**. 3. Follow the Slack prompts to install the `mintlify` app in your workspace and grant the requested permissions. 4. Confirm the connection in your Mintlify dashboard to your Slack workspace. @@ -46,7 +46,7 @@ Use the agent in Slack to update your content, ask questions, and capture team k To remove the agent from your Slack workspace: -1. Navigate to the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click **Configure Slack**. 3. Click **Disconnect** to revoke the connection between Mintlify and your workspace. 4. In Slack, navigate to **Manage apps**. @@ -135,7 +135,7 @@ When a code change automation opens a documentation pull request, it posts a com ## Manage automations -The Slack agent and [Automations](/automations) both use the Mintlify agent. Ask the agent to create, configure, run, or troubleshoot any automation. It can perform every action available to you on the [Automations](https://app.mintlify.com/settings/project/automations) page of your dashboard. +The Slack agent and [Automations](/automations) both use the Mintlify agent. Ask the agent to create, configure, run, or troubleshoot any automation. It can perform every action available to you in your [Automations](https://app.mintlify.com/settings/project/automations) settings. Example prompts: @@ -152,7 +152,7 @@ You can also ask the agent about automation activity, such as recent runs, failu ### Trigger automations from Slack messages -You can configure a custom automation to run when someone posts a top-level message in a chosen Slack channel. The agent reads each message, decides whether it warrants a documentation update, and opens a pull request when it does. Set this up when you create or edit the automation on the [Automations](https://app.mintlify.com/settings/project/automations) page. +You can configure a custom automation to run when someone posts a top-level message in a chosen Slack channel. The agent reads each message, decides whether it warrants a documentation update, and opens a pull request when it does. Set this up when you create or edit the automation in your [Automations](https://app.mintlify.com/settings/project/automations) settings. The `mintlify` app must be a member of the channel you choose. Invite it with `/invite @mintlify` before saving the automation. diff --git a/api/automations/webhook.mdx b/api/automations/webhook.mdx index f08662f66..d843c8429 100644 --- a/api/automations/webhook.mdx +++ b/api/automations/webhook.mdx @@ -16,7 +16,7 @@ This endpoint only supports [custom automations](/automations/create) with a web ## Get the webhook URL and auth header -Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard and click the settings button on a custom automation with a webhook trigger. The trigger card shows the full webhook URL and a **Copy auth header** action for the `Authorization: Bearer ` header template. +Open your [Automations](https://app.mintlify.com/settings/project/automations) settings and click the settings button on a custom automation with a webhook trigger. The trigger card shows the full webhook URL and a **Copy auth header** action for the `Authorization: Bearer ` header template. Replace `` with an unexpired organization API key with write access. Create or manage keys on the [API keys](https://app.mintlify.com/settings/organization/api-keys) page. Automations do not create, store, or rotate keys on your behalf. diff --git a/automations/create.mdx b/automations/create.mdx index 0939df146..d8da82c1c 100644 --- a/automations/create.mdx +++ b/automations/create.mdx @@ -23,7 +23,7 @@ For an overview of triggers, update modes, and configuration options shared acro The agent runs in an isolated sandbox with restricted internet access. It cannot install additional packages or tools at runtime. Prompts that reference unavailable tools may produce unexpected results or fail. -1. Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click **New automation**. 3. On the configure page, set the automation name, trigger, prompt, context repositories, integrations, and update mode. For details on each field, see [Configurations](/automations/manage#configurations). 4. Click **Save**. @@ -64,7 +64,7 @@ Review the run in the [run history](/automations/manage#view-run-history) to see ## Edit a custom automation -1. Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click the settings button on the automation's card to open its configure page. 3. Update any of the fields described in [Configurations](/automations/manage#configurations). 4. Click **Save**. @@ -73,6 +73,6 @@ Review the run in the [run history](/automations/manage#view-run-history) to see Deleting an automation is permanent and removes its configuration and run history. -1. Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click the settings button on the automation's card to open its configure page. 3. Click **Delete automation** at the bottom of the page and confirm. diff --git a/automations/manage.mdx b/automations/manage.mdx index 3ba177d9f..e2dffce58 100644 --- a/automations/manage.mdx +++ b/automations/manage.mdx @@ -14,7 +14,7 @@ import GitlabAutomationSetup from '/snippets/gitlab-automation-setup.mdx'; ## Enable an automation -1. Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click the toggle beside an automation to enable it. If the automation can run with default settings, it activates immediately. Otherwise, the automation's configure page opens so you can fill in any required configurations. @@ -77,7 +77,7 @@ Send Slack messages to one or more channels when automations run. To enable Slack notifications: 1. Install the [Mintlify Slack app](/agent/slack) in your workspace. -2. Click **Configure Slack** on the [Automations](https://app.mintlify.com/settings/project/automations) page of your dashboard. +2. Click **Configure Slack** in your [Automations](https://app.mintlify.com/settings/project/automations) settings. 3. Select one or more channels to send notifications to. 4. Click **Save changes**. @@ -110,7 +110,7 @@ You can add target languages at any time by opening the automation's configure p ## Disable an automation -1. Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click the toggle beside an automation to disable it. When you re-enable a scheduled automation or change its schedule, Mintlify recalculates the next run time from the current time. Disabled automations do not retain a pending run time. @@ -119,7 +119,7 @@ When you re-enable a scheduled automation or change its schedule, Mintlify recal Deletion is permanent and cannot be undone. -1. Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click the settings button on the custom automation's card to open its configure page. 3. Click **Delete automation** at the bottom of the page and confirm. @@ -127,7 +127,7 @@ Deletion is permanent and cannot be undone. You can trigger an automation on demand without waiting for its next scheduled or event-based run. -1. Open the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click the settings button on the automation's card to open its configure page. 3. Click the run button (**Test run** or **Run now**, depending on the automation). 4. Select the run scope. @@ -154,11 +154,11 @@ Runs triggered through the webhook use the automation's saved prompt, read the f ## View run history -The [Runs](https://app.mintlify.com/settings/project/automations?tab=runs) tab on the automations page displays a list of all runs for all automations. +The [Runs](https://app.mintlify.com/settings/project/automations?tab=runs) tab in your Automations settings displays a list of all runs for all automations. A run is one execution of an automation. A run can create a new pull request, update an existing pull request, fail to run, or find nothing to change. -1. Open the [Automations](https://app.mintlify.com/settings/project/automations?tab=runs) page in your dashboard. +1. Open the **Runs** tab in your [Automations](https://app.mintlify.com/settings/project/automations?tab=runs) settings. 2. Use the dropdown menus to filter by specific automations or status. Each result shows one of the following statuses: diff --git a/automations/reference.mdx b/automations/reference.mdx index 48c85d7be..434abd991 100644 --- a/automations/reference.mdx +++ b/automations/reference.mdx @@ -4,7 +4,7 @@ description: "Reference for all predefined Mintlify automations, including defau keywords: ["predefined", "automation", "default"] --- -Mintlify includes predefined automations for the most common documentation maintenance tasks. Each automation has a base prompt and a default configuration. You can customize the trigger, update mode, and instructions from the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard. +Mintlify includes predefined automations for the most common documentation maintenance tasks. Each automation has a base prompt and a default configuration. You can customize the trigger, update mode, and instructions in your [Automations](https://app.mintlify.com/settings/project/automations) settings. ## At a glance diff --git a/guides/use-automations.mdx b/guides/use-automations.mdx index f98f7fb2a..9fc59fbc3 100644 --- a/guides/use-automations.mdx +++ b/guides/use-automations.mdx @@ -29,7 +29,7 @@ Each automation runs on one of four trigger types. Choose the one that matches w ## Predefined automations -Mintlify includes predefined automations for the most common content maintenance tasks. Enable any of them from the [Automations](https://app.mintlify.com/settings/project/automations) page of your dashboard. +Mintlify includes predefined automations for the most common content maintenance tasks. Enable any of them in your [Automations](https://app.mintlify.com/settings/project/automations) settings. See [Predefined automations](/automations/reference) for more details. @@ -102,7 +102,7 @@ Scheduling cron jobs to run at specific times gives you more precise control ove Automations run automatically, but they benefit from periodic review. -1. Open the **Runs** tab on the [Automations](https://app.mintlify.com/settings/project/automations) page to see recent run history and status. +1. Open the **Runs** tab in your [Automations](https://app.mintlify.com/settings/project/automations?tab=runs) settings to see recent run history and status. 2. To see more information about a run, click the actions menu button and select **View run details** to see the prompt, summary, files, and pull request. 3. If results are inconsistent, refine your instructions: add more specific procedures, narrow the file scope, or split the automation into smaller tasks. diff --git a/openapi.json b/openapi.json index 5bc103c0d..8fb985b13 100644 --- a/openapi.json +++ b/openapi.json @@ -396,7 +396,7 @@ { "name": "workflowSchemaId", "in": "path", - "description": "The ID of the automation to trigger. Can be copied from the automation's settings panel on the [Automations](https://app.mintlify.com/settings/project/automations) page in your dashboard.", + "description": "The ID of the automation to trigger. Can be copied from the automation's settings panel in your [Automations](https://app.mintlify.com/settings/project/automations) settings.", "required": true, "schema": { "type": "string" @@ -417,7 +417,7 @@ }, "instanceId": { "type": "string", - "description": "The ID of the queued automation run. Appears in the run history on the [Automation Runs](https://app.mintlify.com/settings/project/automations) page." + "description": "The ID of the queued automation run. Appears on the **Runs** tab of your [Automations](https://app.mintlify.com/settings/project/automations?tab=runs) settings." }, "jobId": { "type": "string",