Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions agent/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

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.

Check warning on line 33 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L33

Did you really mean 'informat'?

Do not include any internal-only information or minor changes like bumping package versions or updating documentation.

Expand Down Expand Up @@ -88,7 +88,7 @@
```

- `repo`: The GitHub repository in `owner/repo` format.
- `branch` (optional): The branch to watch for merges. If you don't specify a branch, the workflow triggers on merges to the repository's default branch.

Check warning on line 91 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L91

Use parentheses judiciously.

A workflow can watch for merges in multiple repositories or branches.

Expand Down Expand Up @@ -118,6 +118,12 @@
automerge: true
```

## Limits

Each workflow can run up to 20 times per 24-hour rolling window. Runs that fail do not count toward this limit.

If a workflow exceeds the limit, additional runs are rejected until older runs fall outside the 24-hour window.

Check warning on line 125 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L125

In general, use active voice instead of passive voice ('are rejected').

## Prompts

Effective prompts focus on one task and have a specific outcome in mind. Workflows always have some variance because of the nondeterministic nature of agents, but you can improve the consistency of workflow outputs by following these best practices.
Expand Down Expand Up @@ -217,7 +223,7 @@

Run weekly to compare English source files against their translations and identify pages that have fallen behind.

To use this workflow, update the example language subdirectories (`es/`, `fr/`, `zh/`) to your actual language subdirectories.

Check warning on line 226 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L226

Use parentheses judiciously.

```markdown .mintlify/workflows/translation-lag.md
---
Expand Down