Skip to content

Update from code changes: document agent publishing options#6349

Open
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/6c837eae
Open

Update from code changes: document agent publishing options#6349
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/6c837eae

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new deployment-level setting that controls whether the agent opens a pull request or commits directly to the deploy branch.

Changes

  • Added "Choose how the agent publishes changes" section to agent/index.mdx describing the pull request vs. push-to-main options, the Mintlify-hosted default, and the branch protection behavior.
  • Removed the outdated claim that the agent never commits directly to the main branch.
  • Updated agent/slack.mdx to reflect that the agent may either open a pull request or push directly, and linked to the new section.
  • Mirrored the changes into the Spanish, French, and Chinese translations.
  • Aligned the setting labels ("Review process", "Create a pull request", "Push to main") with the dashboard UI, and clarified that the setting is hidden entirely when the deploy branch has branch protection.

Context

Triggered by a change that adds a deployment-level review process setting so teams can choose how the agent publishes documentation updates.

Update history

  • Initial commit: documented the deployment-level agent review process setting in English and translated to es, fr, zh.
  • Aligned setting name and option labels with the dashboard dropdown ("Review process", "Push to main") and clarified that branch protection hides the dropdown rather than triggering a fallback (mintlify/mint#8779).

Note

Low Risk
Documentation-only edits with no product or code behavior changes in this diff.

Overview
Updates agent docs (English, Spanish, French, and Chinese) to match the deployment Review process setting, which can publish via pull request or direct commits to the deploy branch.

On agent/index.mdx (and locale equivalents), the workflow step now describes Publishes changes instead of only creating a PR, and drops the blanket statement that the agent never commits to the main branch. A new Choose how the agent publishes changes section explains defaults (PR for review; Mintlify-hosted deploys push to the deploy branch), Create a pull request vs Push to main, and that branch protection hides the setting and forces PRs.

agent/slack.mdx (and locales) now says updates may open a PR or push to the deploy branch per that setting, softens “always opens PR” language for cloned repos, and completion summaries link to a PR or commit.

Reviewed by Cursor Bugbot for commit c9635c8. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 1, 2026, 11:36 PM

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
smartac 🟢 Ready View Preview Jul 1, 2026, 11:36 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview Jul 1, 2026, 11:38 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
adminroletesting 🟢 Ready View Preview Jul 1, 2026, 11:37 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hfh-d7a4d643 🟢 Ready View Preview Jul 1, 2026, 11:36 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gwgwgw 🟢 Ready View Preview Jul 1, 2026, 11:36 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 1, 2026, 11:36 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Aligned review process labels with dashboard UI and clarified branch protection behavior

Source PRs

Comment thread agent/slack.mdx
- **With attachments**: Upload images, diagrams, code files, or other documents with your message. The agent automatically processes and includes them in your documentation. In a thread, the agent has access to images and files shared in earlier messages, so you can reference them in follow-up requests without reuploading.

The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates.
The agent reads the context of the request or thread and updates your connected repository. Depending on your [review process setting](/agent/index#choose-how-the-agent-publishes-changes), the agent either opens a pull request or commits directly to your deploy branch.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The agent reads the context of the request or thread and updates your connected repository. Depending on your [review process setting](/agent/index#choose-how-the-agent-publishes-changes), the agent either opens a pull request or commits directly to your deploy branch.
The agent reads the context of the request or thread and updates your connected repository. Depending on your [review process setting](/agent/index#choose-how-the-agent-publishes-changes), the agent either opens a pull request or commits directly to your deployment branch.

Comment thread agent/index.mdx
- **Creates a PR**: Opens a pull request with proposed changes for review.

All changes go through pull requests. The agent never commits directly to your main branch.
- **Publishes changes**: Opens a pull request with proposed changes for review, or commits directly to your deploy branch, depending on your [review process setting](#choose-how-the-agent-publishes-changes).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Publishes changes**: Opens a pull request with proposed changes for review, or commits directly to your deploy branch, depending on your [review process setting](#choose-how-the-agent-publishes-changes).
- **Publishes changes**: Opens a pull request with proposed changes for review, or commits directly to your deployment branch, depending on your [review process setting](#choose-how-the-agent-publishes-changes).

Comment thread agent/index.mdx

## Choose how the agent publishes changes

By default, the agent opens a pull request for every change so your team can review it before it ships. If your deployment is hosted by Mintlify, the agent commits changes directly to your deploy branch so they publish immediately.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By default, the agent opens a pull request for every change so your team can review it before it ships. If your deployment is hosted by Mintlify, the agent commits changes directly to your deploy branch so they publish immediately.
By default, the agent opens a pull request for every change so your team can review it before it ships. If Mintlify hosts your deployment, the agent commits changes directly to your deployment branch so changes publish immediately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants