LB

Documentation

Letter Builder

Browse documentation pages
Theme aware
Diff Data

Revisions & Audits

Version history, comparisons, restores, and change visibility.

Readable guides Practical edge cases Feature-by-feature navigation

Why revisions and audits matter

Content systems are easy to edit and surprisingly hard to trust without history. When a template changes, teams need to know what changed, when it changed, and whether they can safely go back.

Two different types of history in this app

Revisions

The template revision page focuses on historical content states. It lets users inspect version numbers, see who changed the template, preview older versions, compare them with the current version, and restore a prior version.

Audits

Audit relations provide broader activity visibility. They help answer operational questions such as who modified a record and when.

What the template revisions page currently supports

  • Version-number display with current-version highlighting
  • Change date and human-readable age
  • Actor display, including system-created entries
  • Change summary generation
  • Preview modal for historical versions
  • Comparison modal against the current version
  • Restore action with confirmation

Why restore is powerful but risky

Restoring a version is not just a convenience button. It changes the current working state of a live template. Teams should use restore when they understand why a past version was better, not only because the current one “looks wrong.”

Safe habits around revisions

  • Preview before restoring.
  • Compare with current before making a rollback decision.
  • Tell stakeholders when a production template is being restored.
  • Document the reason for major restores outside the UI if your process requires it.

Edge cases

  • Old version restored after language changes: make sure the restored language content still matches current operational needs.
  • Version summary feels incomplete: summaries are helpful cues, not perfect semantic explanations of every edit.
  • Audit present but content still confusing: use audits and revisions together, not as substitutes for each other.

When to restore a version

  • When a recent change introduced broken placeholders or invalid content.
  • When a prior version is known to be the last approved or business-accepted state.
  • When a restore is easier and safer than manually reconstructing complex multilingual content.

When not to restore immediately

  • When the issue is limited to a small fix that can be corrected safely in the current version.
  • When business rules changed and the old version is now outdated even if it was once valid.
  • When the team has not yet compared the old version against the current one carefully.