From 29426eed5981fb28f7a9fafd1e1b045ffb04b4cd Mon Sep 17 00:00:00 2001 From: paaatrrrick Date: Wed, 15 Apr 2026 14:03:06 -0700 Subject: [PATCH 1/2] Remove Workflow Files --- agent/workflows.mdx | 235 ++++++++------------------------------------ cli/commands.mdx | 12 --- es/cli/commands.mdx | 14 --- fr/cli/commands.mdx | 14 --- zh/cli/commands.mdx | 14 --- 5 files changed, 41 insertions(+), 248 deletions(-) diff --git a/agent/workflows.mdx b/agent/workflows.mdx index 5a09d808f..4ca0d370c 100644 --- a/agent/workflows.mdx +++ b/agent/workflows.mdx @@ -9,6 +9,10 @@ tag: "Beta" Workflows are in beta. They're currently free for all plans during the beta period. Workflow features, availability, and pricing are subject to change. + + File-based workflows (`.mintlify/workflows/*.md`) are deprecated. Existing file-based workflows continue to run, but create and manage all workflows from the dashboard. + + Workflows run the agent automatically on a schedule or on a push to a repository. Each workflow defines a prompt for the agent and a trigger for when to run it. Workflows support both GitHub and GitLab repositories. When a workflow runs, the agent clones any specified repositories as context, follows the prompt, and either opens a pull request (or merge request for GitLab) or pushes changes directly to your deployment branch. @@ -23,8 +27,6 @@ Use workflows that run on push events to automate reactive maintenance tasks lik ## Create a workflow -### Create a workflow in the dashboard - 1. Open the [Workflows](https://dashboard.mintlify.com/products/workflows) page. 2. Click **New workflow**. 3. Configure the workflow name, trigger type, repositories, and schedule. @@ -37,60 +39,17 @@ Use workflows that run on push events to automate reactive maintenance tasks lik The new workflow setup page. -### Create a workflow file with the CLI - -If you have the [Mintlify CLI](/cli) installed, run the following command from your documentation repository to create a workflow file interactively in the CLI. - -```bash -mint workflow -``` - -The CLI prompts you for information about the workflow and creates a `.md` file in the `.mintlify/workflows/` directory. Commit and push the file to activate the workflow. - - - If you run `mint workflow` in a non-interactive environment such as a CI/CD pipeline or an AI coding agent, the CLI returns usage instructions and the workflow file format instead of interactive prompts. - - -### Add a workflow file to your repository - -Create a `.md` file for each workflow in a `.mintlify/workflows/` directory at the root of your documentation repository. Each file defines one workflow. - - -If you have a monorepo, place the `.mintlify/workflows/` folder inside your documentation root directory where your `docs.json` file is, not at the repository root. - - -Workflow files use YAML frontmatter to configure the workflow, followed by a Markdown prompt for the agent. - -```markdown .mintlify/workflows/update-changelog.md ---- -name: Update changelog -on: - cron: "0 9 * * 1" -context: - - repo: your-org/your-product -automerge: false ---- - -Review all changes since the last changelog update. Draft a new changelog post with any new features, bug fixes, or breaking changes. - -Include information about what changed and how it affects users. - -Do not include any internal-only information or minor changes like bumping package versions or updating documentation. - -Success criteria: Someone who reads the changelog knows the most up to date information about the product including what changed and whether or not it affects them. -``` - -## Frontmatter fields +## Configuration | Field | Required | Description | |-------|----------|-------------| -| `name` | Yes | Display name shown in the dashboard. | -| `on` | Yes | Trigger configuration. | -| `context` | No | Repositories cloned as reference when the workflow runs. | -| `automerge` | No | Defaults to `false`, which opens a pull request for review. If `true`, opens a pull request and automatically merges it. | -| `notify` | No | Notification configuration. Send Slack messages when workflows complete. | +| **Name** | Yes | Display name shown in the dashboard. | +| **Trigger** | Yes | Trigger configuration. | +| **Context** | No | Repositories cloned as reference when the workflow runs. | +| **Automerge** | No | Defaults to off, which opens a pull request for review. If enabled, opens a pull request and automatically merges it. | +| **Notify** | No | Notification configuration. Send Slack messages when workflows complete. | -For GitHub repositories, you must have the Mintlify GitHub App installed on every repository listed in the `context` or `on.push.repo` fields. Add new repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) page of your Mintlify dashboard. +For GitHub repositories, you must have the Mintlify GitHub App installed on every repository listed in the context or trigger fields. Add new repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) page of your Mintlify dashboard. For GitLab repositories, each project must be connected via OAuth on the [GitLab OAuth settings page](https://dashboard.mintlify.com/settings/organization/gitlab-oauth). See [GitLab setup](#gitlab-setup). @@ -101,7 +60,7 @@ For GitLab repositories, each project must be connected via OAuth on the [GitLab ### Triggers -Each workflow must define exactly one trigger using the `on` field. +Each workflow must define exactly one trigger. #### On schedule (cron) @@ -109,67 +68,36 @@ Run a workflow on a recurring schedule using a cron expression. All schedules ru Workflows queue within 10 minutes of the scheduled time and may take up to 10 minutes to run. -```yaml -on: - cron: "0 9 * * 1" -``` - The value is a standard 5-field cron expression in `minute hour day-of-month month day-of-week` format. Use a tool like [crontab.guru](https://crontab.guru) to build and validate schedules. | Expression | Schedule | |------------|----------| -| `"0 9 * * 1"` | Every Monday at 9:00 AM UTC | -| `"0 0 1 * *"` | First day of each month at midnight UTC | -| `"0 8 * * 1-5"` | Weekdays at 8:00 AM UTC | +| `0 9 * * 1` | Every Monday at 9:00 AM UTC | +| `0 0 1 * *` | First day of each month at midnight UTC | +| `0 8 * * 1-5` | Weekdays at 8:00 AM UTC | #### On push events Run a workflow when changes push to a specific repository or branch. This includes both pull request merges and direct pushes to the branch. -```yaml -on: - push: - - repo: your-org/your-product - branch: main -``` - -- `repo`: The repository in `owner/repo` format. -- `branch` (optional): The branch to watch for pushes. If you don't specify a branch, the workflow triggers on pushes to the repository's default branch. +Specify each repository in `owner/repo` format. Optionally specify a branch to watch — if you don't, the workflow triggers on pushes to the repository's default branch. A workflow can watch for pushes to multiple repositories or branches. -```yaml -on: - push: - - repo: your-org/your-product - - repo: your-org/another-repo - branch: release -``` - ### Context repositories -Use `context` to give the agent read access to additional repositories when the workflow runs. This is useful when your prompt requires reviewing code or content outside your documentation repository. You can specify up to five context repositories per workflow. - -```yaml -context: - - repo: your-org/your-product - - repo: your-org/design-system -``` +Context repositories give the agent read access to additional repositories when the workflow runs. This is useful when your prompt requires reviewing code or content outside your documentation repository. You can specify up to five context repositories per workflow. ### Auto-merge changes -By default, the agent opens a pull request for each workflow run so you can review changes before they go live. Set `automerge: true` to automatically merge the pull request without requiring manual approval. This gives you a record of changes in your repository's pull request history while automating the merge step. +By default, the agent opens a pull request for each workflow run so you can review changes before they go live. Enable auto-merge to automatically merge the pull request without requiring manual approval. This gives you a record of changes in your repository's pull request history while automating the merge step. For GitHub repositories, automerge requires the Mintlify GitHub App to have bypass permissions on all rulesets that target your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions. - For GitLab repositories, automerge uses the access token configured in your [GitLab integration](/deploy/gitlab). Ensure the token has sufficient permissions to merge a merge requests on the target branch. + For GitLab repositories, automerge uses the access token configured in your [GitLab integration](/deploy/gitlab). Ensure the token has sufficient permissions to merge merge requests on the target branch. -```yaml -automerge: true -``` - ### Slack notifications Send Slack messages when a workflow completes or fails. Notifications include the workflow status, a link to the pull request, and a summary of the changes. @@ -178,44 +106,16 @@ Send Slack messages when a workflow completes or fails. Notifications include th Slack notifications require the Mintlify Slack app in your organization's Slack workspace. Install the Slack app from your [dashboard](https://dashboard.mintlify.com/products/agent). -#### Configure Slack notifications in the dashboard - -When creating or editing a workflow in the dashboard, you can enable Slack notifications under the **Notify on completion** toggle: +When creating or editing a workflow in the dashboard, enable Slack notifications under the **Notify on completion** toggle: 1. If you haven't connected Slack, click **Install Slack app**. 2. Click the **Notify on completion** toggle. 3. Search for and select the channels you want to notify. 4. Save your workflow. -#### Configure Slack notifications in workflow files - -Use the `notify` field to configure Slack notifications in a workflow file: - -```yaml -notify: - slack: - channels: - - documentation - - dev-updates - users: - - alice - - bob -``` - -You can specify notification targets by name or by ID: - -| Field | Description | -|-------|-------------| -| `channels` | Channel names to notify (with or without `#` prefix). | -| `channel_ids` | Channel IDs to notify. | -| `users` | Usernames, display names, or real names to DM. | -| `user_ids` | Slack user IDs to DM. | - ## Manage workflows -If you create a workflow in the dashboard, edit or delete it from the dashboard. - -If you create a workflow from a file in your repository, edit or delete it with a pull request modifying the file. +Edit, delete, disable, or trigger workflows from the [Workflows](https://dashboard.mintlify.com/products/workflows) page in your dashboard. ### Trigger a workflow manually @@ -268,7 +168,9 @@ The agent cannot install additional packages or tools at runtime. Package regist Prompts that instruct the agent to run unavailable tools may produce unexpected results or fail. -## Example workflows +## Example prompts + +These example prompts demonstrate common workflow patterns. Create a workflow in the dashboard and paste the prompt into the instructions field. ### Draft documentation for new features @@ -278,20 +180,10 @@ Prompts that instruct the agent to run unavailable tools may produce unexpected Add this workflow with any modifications for your project to automatically draft documentation as you add new features to your product. -Runs when you push changes to your product repository to identify documentation updates needed for any new features or APIs. - -```markdown .mintlify/workflows/draft-feature-docs.md ---- -name: Draft docs for new features -on: - push: - - repo: your-org/your-product - branch: main -context: - - repo: your-org/your-docs -automerge: false ---- +**Trigger:** On push to `your-org/your-product` (main branch) +**Context repos:** `your-org/your-docs` +```text Review the diff from the last merged PR in `your-org/your-product`. Identify any new features, APIs, or other changes that require documentation. For each new addition, draft documentation updates that explain what it does, when to use it, and how to configure it. Include a code example where relevant. @@ -306,18 +198,9 @@ Success criteria: After reading any new or updated documentation, users understa ### Style audit -Runs when changes push to your documentation repository to catch style guide violations before they accumulate. This example workflow automatically fixes style guide violations and lists any violations that require human judgment in the PR body. - -```markdown .mintlify/workflows/style-audit.md ---- -name: Style audit -on: - push: - - repo: your-org/your-docs - branch: main -automerge: false ---- +**Trigger:** On push to `your-org/your-docs` (main branch) +```text Review all MDX files changed in the last merged PR against the style guide at `path/to/style-guide`. Open a pull request to resolve any style violations that can be fixed automatically. For any edits that require judgment or nuance, note them in the PR body with the specific lines, rule violations, and suggested fixes. @@ -334,20 +217,10 @@ Success criteria: ### Update API reference -Runs when pull requests merge to your product repository to keep API reference pages in sync with your product code. When endpoints or parameters change, this workflow updates the corresponding content in your documentation. - -```markdown .mintlify/workflows/update-api-reference.md ---- -name: Update API reference -on: - push: - - repo: your-org/your-product - branch: main -context: - - repo: your-org/your-docs -automerge: false ---- +**Trigger:** On push to `your-org/your-product` (main branch) +**Context repos:** `your-org/your-docs` +```text Review the diff from the last merged PR in `your-org/your-product` for changes to API endpoints, parameters, response shapes, or error codes. Update the corresponding API specifications or pages in the docs to reflect the changes. Include updated parameter descriptions, type information, and examples where affected. @@ -362,17 +235,11 @@ Success criteria: All API specifications and pages are up to date with the chang ### Track translation lag -Run weekly to compare English source files against their translations and identify pages that have fallen behind. +**Trigger:** Cron schedule `0 9 * * 3` (Wednesdays at 9:00 AM UTC) -To use this workflow, update the example language subdirectories (`es/`, `fr/`, `zh/`) to your actual language subdirectories. - -```markdown .mintlify/workflows/translation-lag.md ---- -name: Track translation lag -on: - cron: "0 9 * * 3" ---- +Update the example language subdirectories (`es/`, `fr/`, `zh/`) to your actual language subdirectories. +```text Compare the English MDX files in the repo against their counterparts in the `es/`, `fr/`, and `zh/` subdirectories. Use git history to identify English files updated more recently than their translations. Open a pull request that lists pages that are out of sync, organized by language. For each page, include the date of the last English update and a brief summary of what changed so translators have context on what to update. @@ -387,16 +254,9 @@ Success criteria: Any discrepancies between the English and translated files are ### SEO and metadata audit -Runs weekly to check for pages with missing or weak metadata and open a pull request with improvements. This example workflow checks for missing, weak, or duplicate `title` and `description` frontmatter and flags boilerplate patterns. Edit the workflow to check for other metadata or content issues that you prioritize for your documentation. - -```markdown .mintlify/workflows/seo-audit.md ---- -name: SEO and metadata audit -on: - cron: "0 9 * * 1" -automerge: false ---- +**Trigger:** Cron schedule `0 9 * * 1` (Mondays at 9:00 AM UTC) +```text Audit all MDX files in the docs for SEO and metadata quality. Check for: - Missing or empty `title` frontmatter @@ -438,24 +298,11 @@ Success criteria: ### Changelog with notifications -Runs weekly to generate a changelog and notify your team on Slack when the workflow completes. This example shows how to combine scheduled workflows with Slack notifications. - -```markdown .mintlify/workflows/changelog-with-notify.md ---- -name: Weekly changelog -on: - cron: "0 9 * * 1" -context: - - repo: your-org/your-product -automerge: false -notify: - slack: - channels: - - documentation - users: - - tech-writer ---- +**Trigger:** Cron schedule `0 9 * * 1` (Mondays at 9:00 AM UTC) +**Context repos:** `your-org/your-product` +**Slack notifications:** `documentation` channel, `tech-writer` user +```text Review all merged PRs in `your-org/your-product` from the past week. Draft a changelog entry summarizing new features, bug fixes, and breaking changes. Success criteria: The changelog accurately reflects the week's changes and is ready for review. diff --git a/cli/commands.mdx b/cli/commands.mdx index a2f80134a..cf4c5474c 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -246,18 +246,6 @@ mint validate [flags] --- -## `mint workflow` - -Create a [workflow](/agent/workflows) file interactively. - -```bash -mint workflow -``` - -The CLI prompts for a name, trigger type, and other settings, then creates a `.md` file in `.mintlify/workflows/`. - ---- - ## `mint export` Export your documentation as a self-contained zip archive for offline viewing and distribution. diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index 8f97be209..8cb1bc794 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -284,20 +284,6 @@ mint validate [flags] --- -
- ## `mint workflow` -
- -Crea un archivo de [flujo de trabajo](/es/agent/workflows) de forma interactiva. - -```bash -mint workflow -``` - -La CLI solicita un nombre, tipo de activador y otros ajustes, luego crea un archivo `.md` en `.mintlify/workflows/`. - ---- -
## `mint export`
diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 6502fe68c..9f20b9380 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -284,20 +284,6 @@ mint validate [flags] --- -
- ## `mint workflow` -
- -Créer un fichier de [workflow](/fr/agent/workflows) de manière interactive. - -```bash -mint workflow -``` - -La CLI vous demande un nom, un type de déclencheur et d'autres paramètres, puis crée un fichier `.md` dans `.mintlify/workflows/`. - ---- -
## `mint export`
diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index 05f74d982..d9e53295b 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -284,20 +284,6 @@ mint validate [flags] --- -
- ## `mint workflow` -
- -以交互方式创建[工作流](/zh/agent/workflows)文件。 - -```bash -mint workflow -``` - -CLI 会提示输入名称、触发器类型和其他设置，然后在 `.mintlify/workflows/` 中创建一个 `.md` 文件。 - ---- -
## `mint export`
From f629db242ebeb3d00b01e19080dde5d2e567afd7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 16 Apr 2026 11:56:11 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- agent/workflows.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/agent/workflows.mdx b/agent/workflows.mdx index ac9678515..7eb87f8c7 100644 --- a/agent/workflows.mdx +++ b/agent/workflows.mdx @@ -9,10 +9,6 @@ tag: "Beta" Workflows are in beta. They're currently free for all plans during the beta period. Workflow features, availability, and pricing are subject to change. - - File-based workflows (`.mintlify/workflows/*.md`) are deprecated. Existing file-based workflows continue to run, but create and manage all workflows from the dashboard. - - Workflows run the agent automatically on a schedule or on a push to a repository. Each workflow defines a prompt for the agent and a trigger for when to run it. Workflows support both GitHub and GitLab repositories. When a workflow runs, the agent clones any specified repositories as context, follows the prompt, and either opens a pull request (or merge request for GitLab) or pushes changes directly to your deployment branch. @@ -80,7 +76,7 @@ The value is a standard 5-field cron expression in `minute hour day-of-month mon Run a workflow when changes push to a specific repository or branch. This includes both pull request merges and direct pushes to the branch. -Specify each repository in `owner/repo` format. Optionally specify a branch to watch — if you don't, the workflow triggers on pushes to the repository's default branch. +Specify each repository in `owner/repo` format. Optionally specify a branch to watch. If you don't specify a branch, the workflow triggers on pushes to the repository's default branch. A workflow can watch for pushes to up to 10 repositories or branches.