Skip to main content

Versioned documentation

Learn about Retool's documentation versioning.

Retool provides multiple versions of product documentation. The version you use depends on whether your Retool organization is cloud-hosted or self-hosted, and the release channel for your self-hosted deployment.

Available versions

VersionDescription
Documentation for features available on Retool Cloud and in the latest Edge channel release of self-hosted Retool.
3.148 Stable
Documentation for features available in the 3.148 Stable channel release of self-hosted Retool.
3.114 Stable
Documentation for features available in the 3.114 Stable channel release of self-hosted Retool.

Cloud and Edge release documentation

Cloud and Edge is the default version of Retool's documentation. It reflects the current product state for Retool Cloud and the latest Edge channel release of self-hosted Retool.

Releases on the Edge channel occur weekly. Each release occurs one week after the equivalent release for cloud-hosted Retool.

Edge releases are available for organizations that want the latest features or to use private beta functionality. Retool recommends most organizations use Stable releases unless you have a specific need for Edge releases and can keep your deployment up-to-date.

Retool supports only the most recent release on the Edge channel. As Edge releases are weekly, bug fixes and improvements are included in the next release. All previous releases are then considered deprecated.

Stable release documentation

Retool releases a version on the Stable channel every 13 weeks (quarterly). A Stable release is generally four versions behind the cloud-hosted version at the time.

Preparation and testing of a Stable version occurs approximately four weeks prior to its release. Stable releases are rigorously tested before they are published. As the release cycle is less frequent, administrators can more easily maintain and upgrade deployments.

Retool supports each Stable release for six months. During this time, Retool will release patch updates that contain bug fixes or security updates. Patch updates do not contain functionality changes and can be applied more quickly than performing a full version upgrade.

Retool provides versioned product documentation for supported Stable releases. When browsing Retool Docs, use the version dropdown menu in the navbar to switch to a relevant version.

After six months, a Stable release is considered deprecated. You can continue using a deprecated release but it will no longer receive updates. At this time, you should upgrade to the latest Stable release.