Skip to content

docs: document context repositories for workflows #5847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 4 commits into from
Closed

docs: document context repositories for workflows #5847

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f9d758
docs: document context repositories for workflows
mintlify[bot] May 17, 2026
9c9be9a
docs: shorten long sentence in context repositories section
mintlify[bot] May 17, 2026
1247e8a
docs: scope context repositories to changelog workflow
mintlify[bot] May 17, 2026
cb3384f
docs: use active voice for changelog context support
mintlify[bot] May 17, 2026
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
8 changes: 8 additions & 0 deletions workflows/enable.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@

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

Add context repositories to give the agent additional source material to read while the workflow runs. The agent clones each context repository alongside your documentation repository so the prompt can reference its files, commits, or pull requests.

Only the changelog workflow supports context repositories. Use them when the agent needs information that lives outside your documentation repository, such as a product codebase that drives release notes.

For GitHub repositories, install the Mintlify GitHub App on each context repository. For GitLab repositories, connect each project through the [GitLab OAuth](https://dashboard.mintlify.com/settings/organization/gitlab-oauth) settings page.

### 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.
Expand Down Expand Up @@ -72,6 +80,6 @@

#### 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 83 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L83 

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

<GitlabWorkflowSetup />
Loading