Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify-docs-editor-agent-panel.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Collaborate with your team on documentation using real-time editing and branch-based workflows.

Real-time collaboration

Multiple people can edit the same page at the same time. Changes from each person appear for everyone on the page. To collaborate on a page in real time, share the editor link for that page with your teammates. See Share a preview for the URL format. When multiple team members edit the same branch, changes sync in real-time. Page content, navigation structure, and site configuration updates appear automatically for all collaborators without refreshing.
  • Each person’s cursor and edits are visible to everyone on the page, with user avatars and names shown in the toolbar.
  • Changes merge automatically. Two people editing the same section won’t cause conflicts.
  • Undo only affects your own changes—undoing won’t revert another person’s edits.
  • If you lose your network connection, your edits save locally and sync when you reconnect.

Chat with the agent in the editor

The agent panel lets you chat with the Mintlify agent directly inside the editor. Open it by clicking the agent icon in the left sidebar. The panel sits to the left of the file explorer so you can chat and navigate files at the same time.

Start a session

Type a prompt in the chat input and press Enter. The agent reads your docs and makes edits on the current branch.

Attach context

Click the paperclip icon in the chat input to attach context to your message. You can attach:
  • Files — any file from your repository
  • Pages — specific documentation pages the agent should read or edit
  • Divisions — a tab, anchor, or other navigation section
  • Inline text — paste text directly into the attachment field
Attaching context focuses the agent on the right part of your docs without requiring you to describe it in your prompt.

Review per-session diffs

After the agent makes changes, a diff summary appears in the chat panel showing the changes. Click any file in the diff summary to navigate to that page in the editor.

Leave feedback

Use the thumbs up and thumbs down buttons in the chat panel to rate the agent’s response. This helps improve future results.

See the agent’s edits in real time

When the Mintlify agent edits a page through the API, MCP, or the agent panel, it appears in the web editor like any other collaborator. If you have the page open on the same branch, you see the agent’s avatar and name at the top of the editor and a live cursor at the location of its most recent edit. Use this to:
  • Watch agent changes stream into the page as they happen.
  • See which paragraph or block the agent just updated without diffing the file.
  • Coordinate with teammates and the agent on the same branch without overwriting each other’s work.
The agent’s cursor clears automatically a short time after the agent finishes editing.

Send content to the assistant

To send highlighted content to the assistant, select text in the editor. A floating toolbar appears above the selection. Click Add to Assistant. The selected content attaches to a new assistant conversation so you can ask questions or request changes without switching context.

Branch-based collaboration

Use branches to work on documentation updates in parallel without affecting your live site. If you aren’t familiar with Git, see Git essentials for the web editor.

Why use branches

  • Isolate changes: Work on updates without affecting your live documentation.
  • Review before publishing: Get feedback from team members before changes go live.
  • Parallel work: Multiple team members can work on different branches simultaneously.
Use pull requests to propose changes and collaborate with your team before merging to your live documentation. This workflow ensures your team reviews changes before publishing and maintains a clear history of updates.
1

Create a pull request

Create a pull request from the editor when you’re ready to publish your changes. See Branching and publishing for more information.
2

Review pull requests

Review pull requests in your Git provider like GitHub or GitLab.
3

Respond to feedback

When reviewers request changes, make the requested changes in the editor. Additional changes automatically push to the existing pull request.
4

Merge pull requests

Merge your pull request after addressing all requested changes, required reviewers approve, and any automated checks pass.
See Share a preview for how to share preview deployment URLs and editor links with your team.