diff --git a/workflows/enable.mdx b/workflows/enable.mdx index 3fe0eb7f5..0eb7ba115 100644 --- a/workflows/enable.mdx +++ b/workflows/enable.mdx @@ -38,6 +38,22 @@ For workflows that run on push events, specify the repositories to watch. You ca For GitHub repositories, you must install the Mintlify GitHub App on each repository. Add repositories on the [GitHub app](https://dashboard.mintlify.com/settings/organization/github-app) settings page. +### Context repositories + +Context repositories are cloned into the workflow's run environment as read-only references so the agent can read their code while it runs. They do not trigger the workflow. + +Use context repositories when the agent needs to read source code, configuration, or other files that live outside your docs repository. For example, point a changelog workflow at your product's backend repository so the agent can summarize recent changes. Or give a custom workflow access to an SDK repository so it can keep code examples accurate. + +Context repositories are available on: + +- Custom workflows +- Changelog workflows (content update, code change, and scheduled variants) +- Other non-maintenance workflows that run on a schedule + +Maintenance workflows (translations, link checks, typo checks, and style checks) operate only on your docs and do not support context repositories. + +To configure them, open the workflow's settings and select repositories from the **Context repositories** picker. The same GitHub App installation or GitLab connection requirements apply as for trigger repositories. + ### Update mode Each workflow has a default mode for how it makes updates, either by directly updating your content repository or by opening a pull request.