Skip to main content
Collaborate with your team on documentation using branch-based workflows, pull requests, and preview deployments. If you aren’t familiar with Git, see Git concepts.

​
Branch-based collaboration

Use branches to work on documentation updates in parallel without affecting your live site.

​
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.
  1. Create a feature branch for your changes.
  2. Make and save your changes on the branch.
  3. Create a pull request when ready for review.
  4. Address feedback and update the branch.
  5. Merge the pull request when approved.
This workflow ensures changes are reviewed before going live and maintains a clear history of updates.

​
Pull request workflow

Pull requests let you propose changes and collaborate with your team before merging to your live documentation.
1

Create a pull request

Create a pull request from the editor when you’re ready to publish your changes. See Publish changes in the web editor for more information on using pull requests.
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 and save your changes. They will automatically push to the existing pull request.
4

Merge pull requests

Merge your pull request when all requested changes are addressed, the pull request is approved by required reviewers, and any automated checks have passed.

​
Preview deployments

Preview deployments create temporary URLs where you can see your changes before they go live.
1

Access preview deployments

  • Click Share in the editor tool bar.
  • Click Preview to open the preview deployment in a new tab.
  • The preview URL shows your documentation with all saved changes applied.
2

Share previews

Share the preview deployment URL with team members to gather feedback. Previews update automatically when you save additional changes.
3

Preview authentication

Preview URLs are publicly accessible by default. Enable preview authentication in the Add-ons page of your dashboard to restrict access to authenticated organization members.