Skip to content

Doc versions ​

The version of these docs is the platform release, the <version> in pom.xml. The current one is 2026.06.30. Page JSON has no separate schema version field. A JSON file runs because the runtime recognizes the keys.

The version menu in the header switches between this edition and editions that have been frozen. A frozen edition is a copy of the articles at release time. Later field notes do not change it.

Freeze the current edition ​

From the docs/ directory:

bash
node scripts/snapshot.mjs 2026.06.30

The script copies guide/, reference/, and zh/ into archive/2026.06.30/. Links between articles are relative, so the copy still points at pages inside the same edition.

Then edit docs/.vitepress/config.mjs:

  • Set platformVersion to the new platform version.
  • Add an item on the English version menu, for example { text: '2026.06.30', link: '/archive/2026.06.30/guide/what-is' }.
  • Add an item on the Chinese version menu, for example { text: '2026.06.30', link: '/archive/2026.06.30/zh/guide/what-is' }.

The sidebar always points at the current edition. An old article keeps its old text, and the sidebar still jumps to the current edition. To walk the old edition, follow links in that edition’s text.

When the platform version changes and the field notes do not, only platformVersion changes. Make a copy when this edition has been handed to someone else and the next edition’s field notes are about to diverge.

This describes the platform. One customer’s business tables are not in these docs.