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
35 changes: 35 additions & 0 deletions workflows/enable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,43 @@

#### Run a translation immediately

After saving the workflow, click **Translate now** to run it on demand using the currently saved target languages. The workflow must be enabled to trigger a manual run. Manual runs do not affect the workflow's regular trigger.

Check warning on line 75 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L75

In general, use active voice instead of passive voice ('be enabled').

## New feature updates

The **New feature updates** workflow watches one or more source code repositories and opens documentation pull requests for the user-facing changes shipped in them. The agent reviews merged source pull requests, groups the work by product or feature area, and opens a separate docs pull request for each group.

Use this workflow when your documentation and source code live in different repositories and you want docs to stay in sync as features ship.

### Triggers

This workflow supports both schedule and push triggers. Pick the trigger that matches how you want docs updates to land.

- **Schedule.** On each run, the agent reviews source pull requests merged since the previous run (or the last 7 days on the first run) and batches updates into separate docs pull requests grouped by product or feature area. Use a schedule when you ship frequently and prefer batched, reviewable docs updates.
- **Push.** The agent runs when a pull request merges in a watched source repository and opens docs updates for that specific pull request. Use push when you want docs updates to track each release as it merges.

### Context repositories

Add the source code repositories you want the agent to watch as context repositories. The agent only reviews pull requests from these repositories.

- You can specify up to 10 repositories per workflow.
- For GitHub repositories, install the Mintlify GitHub App on each repository. Add repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) settings page.
- For GitLab repositories, connect a GitLab account with access to each project.

### Instructions

Use the optional instructions field to tell the agent about your product surface, style requirements, or which kinds of changes to prioritize or skip. For example, you can ask the agent to focus on a specific product area or to ignore internal-only repositories.

### How batched updates work

On scheduled runs, the agent:

1. Gathers source pull requests merged in the run window from each context repository.
2. Groups the required documentation work by product or feature area, up to a fixed maximum per run.
3. Opens one docs pull request per group, each containing only the changes for that product or feature.

Each pull request links back to the source pull requests it documents, so you can review changes in focused, product-scoped chunks instead of one large update.

## Improve docs from assistant chats

The **Improve docs from assistant chats** workflow reviews recent trends in [assistant](/assistant/index) questions and opens targeted documentation updates that address gaps your users hit.
Expand All @@ -90,6 +125,6 @@

When a run completes, the run detail in your dashboard includes the specific feedback citations the agent used. Each citation links to the feedback in your [analytics dashboard](https://dashboard.mintlify.com/products/analytics/v2/feedback) so you can verify the context that drove the update.

This workflow runs on a schedule and requires that feedback collection is enabled on the [Add-ons](https://dashboard.mintlify.com/products/addons) page. It does not require trigger repositories or extra context configuration.

Check warning on line 128 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L128

In general, use active voice instead of passive voice ('is enabled').

<GitlabWorkflowSetup />
Loading