From a8bf5207d9c794bb70461755bd18b8cd8ccedd83 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 20 Feb 2026 17:26:06 -0800 Subject: [PATCH 1/3] rename existing workflows file to use cases --- agent/{workflows.mdx => use-cases.mdx} | 4 ++-- docs.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename agent/{workflows.mdx => use-cases.mdx} (94%) diff --git a/agent/workflows.mdx b/agent/use-cases.mdx similarity index 94% rename from agent/workflows.mdx rename to agent/use-cases.mdx index 23d99fe83..d24723fe5 100644 --- a/agent/workflows.mdx +++ b/agent/use-cases.mdx @@ -1,10 +1,10 @@ --- -title: "Workflows" +title: "Use cases" description: "Examples of using the agent in your documentation process." keywords: ["agent workflows", "documentation workflows", "automation examples"] --- -The agent assists with many different documentation tasks. These workflows show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs. +The agent assists with many different documentation tasks. These examples show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs. ## Iterate on a prompt in a Slack thread diff --git a/docs.json b/docs.json index e78206de1..0a3b5d16f 100644 --- a/docs.json +++ b/docs.json @@ -85,7 +85,7 @@ "agent/suggestions", "agent/customize", "agent/effective-prompts", - "agent/workflows" + "agent/use-cases" ] }, { From 305d00839a9af3125613b2aa813f9f66512ba696 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 20 Feb 2026 17:53:00 -0800 Subject: [PATCH 2/3] add new workflows page --- agent/workflows.mdx | 116 ++++++++++++++++++++++++++++++++++++++++++++ docs.json | 1 + 2 files changed, 117 insertions(+) create mode 100644 agent/workflows.mdx diff --git a/agent/workflows.mdx b/agent/workflows.mdx new file mode 100644 index 000000000..3d205bcc5 --- /dev/null +++ b/agent/workflows.mdx @@ -0,0 +1,116 @@ +--- +title: "Workflows" +description: "Automate documentation maintenance with scheduled or event-triggered agent tasks." +keywords: ["automation", "automate", "cron", "auto-update"] +--- + + + Workflows are available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=agent). + + Pro plans can have up to two active workflows. Enterprise plans can have up to 10 active workflows. + + +Workflows run the agent automatically on a schedule or when an event you specify happens in one of your repositories. Each workflow defines a prompt for the agent and a trigger for when to run it. + +When a workflow runs, the agent follows the prompt, makes changes to your documentation, then either opens a pull request or pushes changes directly to your deploy branch depending on how you configure the workflow. + +## Create a workflow file + +Create `.md` files in a `.mintlify/workflows/` directory at the root of your documentation repository. Each file defines one workflow. + +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 a change is and how it affects users. + +Do not include any internal-only information or minor changes +like bumping package versions or updating documentation. +``` + +### Frontmatter fields + +| 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. If `true`, pushes changes directly to your deployment branch. | + +You must have the Mintlify GitHub App installed on every repository listed in the `context` or `on.push.repo` fields. See [GitHub](/deploy/github) for more information on how to install the app. + +The content below the frontmatter is the prompt the agent follows when the workflow runs. + +## Triggers + +Each workflow must define exactly one trigger using the `on` field. + +### On schedule (cron) + +Run a workflow on a recurring schedule using a cron expression. All schedules run in UTC. + +```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 | + +### On merge + +Run a workflow when a pull request merges to a specific repository and branch. + +```yaml +on: + push: + - repo: your-org/your-product + branch: main +``` + +- `repo`: The GitHub repository in `owner/repo` format. +- `branch`: The branch to watch for merges. Omit to trigger on merges to the repository's default branch. + +A workflow can watch for merges in multiple repositories or branches. + +```yaml +on: + push: + - repo: your-org/your-product + - repo: your-org/another-repo + branch: release +``` + +## Reference 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. + +```yaml +context: + - repo: your-org/your-product + - repo: your-org/design-system +``` + +## 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 push changes directly to your deploy branch without a pull request. + +```yaml +automerge: true +``` diff --git a/docs.json b/docs.json index 0a3b5d16f..a5ffe74e5 100644 --- a/docs.json +++ b/docs.json @@ -82,6 +82,7 @@ "pages": [ "agent/quickstart", "agent/slack", + "agent/workflows", "agent/suggestions", "agent/customize", "agent/effective-prompts", From 3bdcad82ca967c437eaac59b6e3e27e5dcd981d7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 20 Feb 2026 17:56:15 -0800 Subject: [PATCH 3/3] add link to agent index --- agent/index.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/agent/index.mdx b/agent/index.mdx index 2f39b25e0..f409d6298 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -38,6 +38,7 @@ Use the agent to: The agent panel open in the dashboard. The agent panel open in the dashboard. +- **Workflows**: Create workflows to run the agent automatically on a schedule or when an event you specify happens in one of your repositories. See [Workflows](/agent/workflows) for more information. - **Slack**: Add the agent to your Slack workspace and mention `@mintlify` in any channel. You can attach files and images directly to your messages for the agent to process. - **API**: Embed the agent in custom applications using the [agent endpoints](/api/agent/create-agent-job).