Docs Ahoy documentation

Change requests and review

On this page
  1. Who does what
  2. The life of a change request
  3. When a merge can't go ahead
  4. Change requests that sit still
  5. Page history
  6. Sharing a change for review
  7. Undoing a merged change

Every change to a library goes through a change request: a named set of draft edits that goes live in one step, when it is merged. Readers never see half a change.

Who does what

Writers of a library see its change requests (owners and admins are writers everywhere). Each change request has one owner, the person who opened it: only they edit it. Any writer of the library can merge it. A team admin can hand a change request to another writer.

The life of a change request

  1. Open. Press Edit on any page and give the change request a title. Edits, new pages, moves, renames, translations and deletions all collect in it.
  2. Preview. See the changed pages as readers will.
  3. Review. The change request's page lists what it changes and shows the changes in detail: the text compared word by word, moved and renamed pages, images added or removed.
  4. Merge. Merge and publish puts everything live at once. The published site updates within seconds. Or Close without merging: the drafts stay readable, nothing goes live.

The owner gets an email when someone else merges, closes or reassigns their change request.

When a merge can't go ahead

The merge checks first, and lists what stands in the way:

  • Conflict: someone else changed the same page since you started.
  • Gone: something you edit was deleted or moved to the trash since.
  • Still linked: you delete a page that other pages still link to.

Nothing is merged until the problems are resolved.

Change requests that sit still

An open change request with no activity for 90 days is deleted. Its owner gets an email warning before that happens; any change keeps it.

Page history

History in a page's bar lists every merged change to that page, newest first, with who merged it and when. Each entry opens that change's comparison.

Sharing a change for review

On an open change request, Create share link makes a link to its summary, comparison and preview, read-only. It works for people who are signed in and can read the library, and only while the change request is open.

Undoing a merged change

Revert on a merged change request opens a new change request that puts back what it changed: deleted pages restored, new ones removed, moves and edits undone. It goes live only when that one is merged, so you can look before you undo. If something changed again after the original merge, it is marked, because reverting undoes that later change too.