Writing in ReadMe

On This Page

Edit & Save

Editing and saving changes is the most straightforward way to make changes in ReadMe. Changes are live immediately once you hit save. If you make a mistake, you can edit & save again, or open history and revert to a previous save.

Branches

With branches, editors and admins can write without committing to publishing right away. It’s ideal for writing about feature releases, or reorganizing a section. Branches work just as well for small changes when your team prefers a review before anything goes live. If you sync with GitHub, GitLab, or Bitbucket, any branches you create will sync with ReadMe.

Enterprise customers can limit who can merge:

• Only Admins: Admin roles will be able to merge any branch; regardless of Review status.
• Admins & Editors: Either an Admin or Editor can merge any branch; regardless of Review status.

See Branches for more detail.

Reviews

Reviews enable writers and teams to check changes with teammates and the AI Linter before they’re ultimately published. Writers can request a review from the Review tab to notify them in-app. Reviewers can approve changes to enable merging.

See Review for more detail.

Enterprise Reviews

Enterprise customers can require branches to enforce their custom styleguide or a teammate approval. Group Admins can find the settings under Project where they can set requirements before a merge can happen:

• Zero Lint Errors: Only allow merging if the AI Linter does not return any errors for the edited pages.
• Teammate Approval: Only allow merging if another teammate has approved. Group Admins can decide if an Editor approval is sufficient, or if an Admin will need to approve explicitly.
  • Admins Only: Only Admin roles can approve changes.
  • Admins & Editors: Either an Admin or Editor can approve changes.

Review Dashboard

Group Editors & Admins can access the Reviews page to see branches that require review across all projects. They can search and filter for the projects that are of note to them.

Review Notifications

Teammates are notified when a branch is marked ready for review or merged, and the requester is notified when their branch is approved. Manage notification preferences from the notification modal.

See Notifications for more detail.

More Ways to Write