How to collaborate on change requests

Learn how to work with your team in GitBook using change requests

Change requests are GitBook’s way of safely collaborating on documentation — similar to pull requests for code. They let you propose, review, and refine updates before anything goes live.

This video and guide will take you through change requests in GitBook, covering:

• Creating change requests to edit content

• Reviewing edits with diff view

• Tracking changes in the Changes tab

• Previewing changes

• Merging and publishing your content live

1

Create a change request

Create a change request before editing published docs. This keeps your work separate from live content.

If you’re new to the workflow, start with change requests.

2

Make and review edits

Edit content inside the change request, like you normally would. Use comments to leave feedback and collaborate in-context.

3

Track changes and preview

Open the Changes tab (aka diff view) to review what’s been modified.

Use Preview to see exactly what will ship after merge.

4

Request reviews (optional)

Request a review when you need another set of eyes. This keeps the workflow clear and encourages discussion before publishing.

If you don’t tag reviewers, everyone with reviewer permissions in the space gets a notification. If the space has no reviewers, GitBook notifies the next role above reviewer instead.

If you need tighter controls, combine reviews with merge rules.

5

Merge when ready

When everything looks good, click Merge. Your changes will go live immediately.

6

Use merge rules (optional)

Set up merge rules to define what must happen before merge. For example, require one or more reviews for approval-heavy teams.