New: AI Insights are here.
See what your users are asking.
⌘Ctrlk
Pricing Log in Sign up
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Change requests

Collaborate on content edits through change requests

A change request is a copy of your main content. It's based on the concept of branching, and feels familiar to anyone who uses pull requests in GitHub or merge requests in GitLab.

In a change request, you can edit, update, and delete content, request reviews on your changes, then merge them back into your main version.

To manage open change requests across your organization, see the Change requests screen .

Review changes in diff view

Open the Changes tab to review edits in a change request. You can review all pages in context, or focus on changed pages only.

By default, changes are shown in a "split-view". The left showing the 'before' version of the page, and the right showing the 'after' state. If you prefer to view changes inline in a single column-layout, click the diff-mode button at the top-right of the Table of contents panel.

Create and merge a change request

1

Open a change request

To edit content, open a change request. You can open one in a few ways:

  • Click Edit in the top right corner of a space.

  • Ask GitBook Agent to create one on your behalf.

  • GitBook Agent may create one automatically when it detects a documentation gap.

If you open one manually, GitBook creates the change request and opens it in the editor.

2

Make your changes

Edit content directly in the editor, or work with GitBook Agent.

Review your changes before you move on. You can keep editing until you're ready to request a review.

3

Request a review

Open the Overview tab, then tag one or more reviewers.

Reviewers can approve your changes, leave comments, or request more edits. If you don't tag anyone, everyone with reviewer permissions in the space is notified. If the space has no reviewers, editors and admins are notified instead.

If someone requests changes, update the change request before you merge it. You can also ask GitBook Agent to review the change request.

4

Merge

Once the change request is approved, open the Overview tab and click Merge.

GitBook applies the changes to your live docs immediately. If your space uses merge rules, GitBook checks them before merging.

Merging can't be undone. To revert or adjust content, open a new change request.

Working with change requests

Change request screen

View and manage change requests across your entire organization

Change requests in a space

Create and review change requests in a single space

Last updated

Was this helpful?

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /