Change requests

Collaborate on content edits through change requests

A change request is a copy of your main content. It comes from the simple concept of branching, and will feel familiar to anyone who uses pull requests in GitHub or merge requests in GitLab.

In a change request, you can edit, update and delete elements of your content, request reviews on your changes, then merge them back into your main version to apply all the changes you made.

To learn more about managing open change requests, head to reviewing change requests.

A GitBook screenshot showing the change requests panel
Edit your content through change requests.
1

Open a change request

To start editing content, you’ll need to start by creating a change request. Change requests can be opened:

2

Make your changes

After a change request is opened, you’re free to make any edits or changes. Changes can be made by working directly in the editor, or by working with Docs Agent.

3

Request a review

Once your changes are ready to go, you can request a review from your team in the Overview tab. Tagging reviewers in a change request will notify them, and allow you to further collaborate in the change request by directly making more changes in the editor, or discussing changes in comments.

You can request Docs Agent for any reviews, or anyone on your team with the right permissions.

4

Merge

After your reviews are done, you’ll be able to merge your changes to publish them to your live docs site immediately!

Working with change requests

Last updated

Was this helpful?