Skip to content

Manage releases

Releases let you bundle documentation updates and publish them as a coordinated snapshot. Use releases to align documentation changes with product launches, versioned releases, or scheduled updates.

Before you begin

This feature requires the Enterprise capability tier (the Business ). During the beta, every project is on the free Solo tier, so this feature is locked by default: go to Settings ▸ Billing and request Enterprise access to unlock it.

Release lifecycle

Every release moves through 3 stages:

Status

Meaning

Draft

In preparation: maps and topics can be added or removed

Published

Live: a frozen snapshot of all included topics has been captured

Archived

Historical: no longer active, kept for reference and comparison

Create a release

  1. Go to Releases in the sidebar.

  2. Click New Release.

  3. Enter a title: for example, "v3.2 Launch" or "June 2026 Update."

  4. Optionally add a description summarizing what this release covers.

  5. Click Create.

The release is created in Draft status.

Add maps to a release

  1. Open the release.

  2. Click Add Map.

  3. Select one or more maps to include.

All topics in the selected maps will be included in the release snapshot when published.

Publish a release

  1. Open the draft release.

  2. Click Publish Release.

  3. Confirm.

Publishing captures a frozen snapshot of every topic in the included maps at that moment. Future edits to topics do not change the snapshot.

Publishing a release is a one-time action. The snapshot is immutable. You cannot edit it after publishing. To make changes, create a new release.

Changes to content reach your published site within 24 hours as its cache refreshes. To push updates live right away, click Update on the affected .

Archive a release

  1. Open a published release.

  2. Click Archive.

  3. Confirm.

Archived releases remain accessible for reference and comparison but are no longer considered active.

Compare releases

Compare two releases to see what changed between them:

  1. Open a release.

  2. Click Compare and select another release.

  3. The comparison shows a side-by-side diff with:

    • Added: topics present in the newer release but not in the older one.

    • Removed: topics present in the older release but not in the newer one.

    • Changed: topics present in both releases with different content, displayed with block-level content diffs highlighting the specific changes.

Use release comparison to build release notes. The side-by-side diff view shows exactly what documentation changed between versions: added topics, removed topics, and block-level content changes within existing topics.

See also

Was this page helpful?