Branching
Create and review documentation changes in isolation, so nothing reaches your live hub until your team has approved it.
Branching (Documentation-focused)
Best for teams that:
- Are documentation-heavy
- Work with multiple contributors
- Release frequently (weekly or faster)
- Review content asynchronously
How it works:
Branches let you create and review content in isolation without affecting the live version of your documentation. Teams can:
- Work on multiple updates in parallel
- Save changes without publishing
- Review updates before merging them live
- Publish content on your own schedule
If your team prefers writing in Markdown or managing docs in source control, syncing ReadMe with GitHub, GitLab, or Bitbucket unlocks a more reviewable workflow.
- Docs live in your GitHub repo as
.mdfiles (MDX supported) - Changes pushed to GitHub appear in ReadMe
- Changes made in ReadMe sync back to GitHub
- Branches sync too: create them in GitHub or ReadMe
Features to Set up
- Bi-Directional Sync with GitHub or GitLab (recommended)
Learn More: Branches, Reviews & Notifications
Updated 12 days ago
Did this page help you?