Skip to main content

Documentation releases

The Cloudflare Pages site has two documentation tracks:

  • Latest (main) at /docs is rebuilt whenever main changes.
  • Major snapshots at paths such as /docs/1.x come from the documentation present in the exact major release tag.

Tags that create a major snapshot​

The publisher recognizes exact tags:

v1.0.0
v1.0.0.0
v2.0.0
v2.0.0.0

Patch, prerelease, and arbitrary tags do not open another major documentation line. If more than one accepted tag exists for the same major, the highest version wins.

Release procedure​

  1. Finish and verify the version's public docs and its matching OpenAPI, configuration schema, default configuration, and example configuration before creating the tag.
  2. Create the major tag on the release commit.
  3. Push the tag.
  4. The Documentation workflow checks out current main, reads the tagged docs and contracts into a temporary Docusaurus version, and publishes Latest plus every complete major snapshot together to Cloudflare Pages. A tag missing any required contract is skipped.
  5. Open the version menu and verify both Latest and the new N.x pages.

Generated versioned_docs, versioned_sidebars, versions.json, and static/versioned-contracts files are build artifacts. The links inside each snapshot resolve to its tag-matched contracts rather than Latest. The copied configuration schema uses a snapshot-specific $id and links back to that documentation version while retaining the tag's validation rules. Do not edit or commit these outputs.

Last updated on