-
Notifications
You must be signed in to change notification settings - Fork 238
Update from code changes: document agent publishing options #6349
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.
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
Open
mintlify
wants to merge
4
commits into
main
Choose a base branch
from
mintlify/6c837eae
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+74
−24
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4a46045
docs: document agent publishing options
mintlify[bot] e6c6e82
docs: translate agent publishing options to es, fr, zh
mintlify[bot] 2602baf
Merge remote-tracking branch 'origin/main' into mintlify/6c837eae
mintlify[bot] c9635c8
docs: align review process wording with dashboard labels
mintlify[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -12,9 +12,7 @@ | |||||
| - **Plans**: Creates a structured task list for complex documentation work. | ||||||
| - **Writes**: Generates or updates content following writing standards and best practices. | ||||||
| - **Validates**: Runs Mintlify CLI checks to ensure documentation builds correctly. | ||||||
| - **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). | ||||||
|
|
||||||
| ## What you can do with the agent | ||||||
|
|
||||||
|
|
@@ -36,6 +34,19 @@ | |||||
|
|
||||||
| By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://app.mintlify.com/settings/account) page of the dashboard. | ||||||
|
|
||||||
| ## 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. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| For deployments connected to your own Git provider, you can change how the agent publishes changes in the **Review process** setting on the [Agent](https://app.mintlify.com/products/agent) page of your dashboard: | ||||||
|
|
||||||
| - **Create a pull request**: The agent commits to a new branch and opens a pull request against your deploy branch. Use this option when you want a human to review changes before they publish. | ||||||
| - **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging deployment. | ||||||
|
|
||||||
| <Note> | ||||||
| If your deploy branch has branch protection rules that block direct pushes, the **Review process** setting is hidden and the agent always opens a pull request. | ||||||
| </Note> | ||||||
|
|
||||||
| ## Connect repositories as context | ||||||
|
|
||||||
| The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new). | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -75,7 +75,7 @@ | |||||
|
|
||||||
| Example questions: | ||||||
| - "Which pages mention the API rate limit?" | ||||||
| - "How do I set up authentication?" | ||||||
| - "How is our navigation structured?" | ||||||
|
|
||||||
| ## Update documentation | ||||||
|
|
@@ -86,7 +86,7 @@ | |||||
| - **Existing thread**: Reply in the thread and mention `@mintlify` with instructions on what to update. | ||||||
| - **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. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Reference other repositories | ||||||
|
|
||||||
|
|
@@ -100,7 +100,7 @@ | |||||
| - "Document the new endpoints added in `acme/backend#1234`." | ||||||
| - "What repositories do you have access to?" | ||||||
|
|
||||||
| The agent treats cloned repositories as read-only. It uses them for context, but always opens pull requests against your documentation repository. | ||||||
| The agent treats cloned repositories as read-only. It uses them for context, but only writes changes to your documentation repository. | ||||||
|
|
||||||
| ## Track progress in real time | ||||||
|
|
||||||
|
|
@@ -111,7 +111,7 @@ | |||||
| - **Questions**: If the agent needs more information, it presents options for you to select from or reply in the thread with a custom answer. | ||||||
| - **Permission requests**: Before the agent runs a third-party action that writes data, such as sending an email or creating a ticket, it asks you to approve or deny the action. The permission request is only visible to the person who triggered the request. Click **Approve** to let the agent proceed or **Deny** to cancel the action. | ||||||
| - **Interruptions**: If you send a follow-up message while the agent is still working, it stops the current task and starts on the new one. | ||||||
| - **Completion**: When the agent finishes, it posts a summary with a link to the pull request and a link to open the changes in the web editor. | ||||||
| - **Completion**: When the agent finishes, it posts a summary with a link to the pull request or commit and a link to open the changes in the web editor. | ||||||
|
|
||||||
| ## Roles and permissions | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.