Documentation Versioning Strategy

ZoopFlow documentation follows a structured versioning approach to ensure users always have access to documentation that matches their version of the framework.

How Versions Work

Each version of the documentation corresponds to a specific release of the ZoopFlow framework:

  • Latest - The most recent stable release
  • Version-specific (e.g., v1.0.0) - Documentation for specific versions
  • Pre-release (e.g., v0.x) - Documentation for pre-release versions

Version Structure

Each documentation version includes:

  • Core concepts
  • Guides
  • API reference
  • Examples
  • Tutorials (when available)

Version Selection

A version selector is available throughout the documentation to switch between versions. The selector is located in the navigation bar.

When viewing documentation, always check that you're looking at the version that matches your installed version of ZoopFlow.

Version Maintenance

  • Latest - Updated with each new release
  • Specific versions - Created at release time and remain static
  • Pre-release - Updated frequently during development

Finding the Right Version

To find documentation for your specific ZoopFlow version:

  1. Check your installed version in your package.json file
  2. Select the matching version from the version selector

If an exact version match isn't available, select the closest earlier version.

Version Compatibility

ZoopFlow follows semantic versioning (SemVer):

  • Major version changes (x.0.0) - Breaking changes
  • Minor version changes (0.x.0) - New features, backward compatible
  • Patch version changes (0.0.x) - Bug fixes, backward compatible

Documentation for a specific minor version (e.g., v1.1.0) should be compatible with all patch versions of that release (e.g., v1.1.1, v1.1.2, etc.).

Migration Guides

When breaking changes occur between versions, migration guides are provided to help users upgrade:

These guides document breaking changes and provide step-by-step instructions for updating your code.