Skip to main content

Compatibility

Use this page when you need the public-safe compatibility model for channels, support windows, and upgrade expectations across the Helpifyr docs platform.

When to use this page​

  • You need to know which public channels are expected.
  • You are planning an upgrade or migration path.
  • You need to interpret versioned product docs or redirect behavior.

Prerequisites​

  • You have read Upgrade and Migrate.
  • You understand that product-specific compatibility truth may still live in versioned product pages.

Compatibility model​

Current default public posture:

  • stable and latest are required public channels for published product docs
  • legacy public paths should redirect to canonical versioned product paths
  • compatibility claims should come from owner-backed source truth rather than ad hoc prose

Architecture / Flow​

Step-by-step procedure​

1. Start with the docs channel model​

Use the docs platform and product pages to verify whether a tool exposes the expected public channels.

2. Check product-specific compatibility pages​

When exact product constraints matter, use the versioned product family, for example:

  • /products/<tool>/stable/compatibility
  • /products/<tool>/latest/compatibility

3. Verify redirect and publication behavior​

Compatibility is not only about version text. It also includes whether users land on the correct canonical page.

4. Pair compatibility with upgrade verification​

Use compatibility pages to choose a path, then use upgrade pages and readback to verify the result.

Verification​

This page is being applied correctly when:

  1. the relevant public channel is identified
  2. compatibility claims are tied to owner-backed source pages
  3. redirects and canonical versioned paths are part of the check

Common failure modes​

Treating compatibility as a generic statement​

Problem:

  • readers do not know which versioned page to trust.

Better path:

  • direct them to the exact product channel page

Ignoring redirect behavior​

Problem:

  • the right content may exist but users still land on stale or ambiguous paths.

Better path:

  • verify canonical versioned publication and redirects

Source Truth​

Next paths​