diff --git a/workflows/enable.mdx b/workflows/enable.mdx index a465adc8c..ee13ef5c7 100644 --- a/workflows/enable.mdx +++ b/workflows/enable.mdx @@ -74,6 +74,41 @@ You can change the target languages at any time by opening the workflow's settin 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. +## 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.