Table of Contents

Article Backups, Revisions, and Versioning

Taylor Sloane Updated by Taylor Sloane

HelpDocs is designed to be used as a team. But sometimes when you have a lot of users working on an article things get messed up. Or you delete something you shouldn't have. Or make a change you regret 😢

That's why HelpDocs ships with non-destructive version control.

Every 5 minutes we check for a new save of your article and create a version from that. Then if you need to you can Browse previous versions and Restore to that point in time.

For every version we save:

  • A version number
  • A unique id to prevent collisions (something you'll never directly use)
  • The article body
  • The user_id of the user that's making the change

We also give you a button to instantly restore the article to its previous state.

HelpDocs saves the 10 most recent versions of all your articles.

Browsing and Restoring Versions

  1. In the article editor click Versions in the bottom left of the text editor
  2. You'll see all the saved versions as tabs at the top of the screen. Click one to select it.
The version preview might not display all your custom styles. Once you restore a version you'll see them in the article preview.
  1. To restore the version hit Restore Version

Compare Versions

  1. In the article editor, click Versions in the bottom left of the text editor
  2. To the right you'll see a dropdown. Select a version to compare with the current one
  3. You'll see additions in green and deletions in red

Restore Unsaved Changes

Accidentally navigated away from the page and lost your changes? With some internet magic you can restore the article you just lost by selecting version zero (V0) 🪄

Versioning modal showing V0 highlighted in red and the version 0 article on the right
  1. In the article editor click Versions in the bottom left of the text editor
  2. You'll see all the saved versions as tabs at the top of the screen
  3. Click V0
  4. Hit 🔄 Restore to get your changes back

Of course, we hope this never happens to you—and recommend you save often—but if it does just know there's a version zero waiting for you just in case 😌 

What did you think of this doc?

Managing Clips

Get in touch

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.