Update from code changes: document agent publishing options#6349
Update from code changes: document agent publishing options#6349mintlify[bot] wants to merge 4 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Update from code changes updated this PR. Aligned review process labels with dashboard UI and clarified branch protection behavior Source PRs
|
| - **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. |
There was a problem hiding this comment.
| 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. |
| - **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). |
There was a problem hiding this comment.
| - **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). |
|
|
||
| ## 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. |
There was a problem hiding this comment.
| 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. |
Summary
Documents the new deployment-level setting that controls whether the agent opens a pull request or commits directly to the deploy branch.
Changes
agent/index.mdxdescribing the pull request vs. push-to-main options, the Mintlify-hosted default, and the branch protection behavior.agent/slack.mdxto reflect that the agent may either open a pull request or push directly, and linked to the new section.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
es,fr,zh.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.