Skip to content

docs: correct the o1js version wording on the offchain storage page - #1239

Open
dkijania wants to merge 1 commit into
mainfrom
docs/offchain-storage-version
Open

docs: correct the o1js version wording on the offchain storage page#1239
dkijania wants to merge 1 commit into
mainfrom
docs/offchain-storage-version

Conversation

@dkijania

@dkijania dkijania commented Sep 6, 2026

Copy link
Copy Markdown
Member

Closes #1230.

The prerequisites section said:

To use OffchainState, import Experimental from o1js version 1.9.1 or higher.

Current stable o1js is 2.15.0. That line is two major versions out of date, and a floor of "1.9.1 or higher" tells a reader nothing about which version the page was actually written against.

What I checked

The API itself is fine. Experimental.OffchainState and OffchainStateCommitments are still exported in 2.15.0, and the usage pattern on this page still matches. Only the version line was wrong — so this PR does not touch the code samples.

What changed

  • States 2.15.0 as the verified version rather than a stale floor.
  • Links both symbols to their o1Labs API reference entries (OffchainState, OffchainStateCommitments) — the page previously had no link to either.
  • Adds a :::caution noting that the Experimental import path carries no stability guarantee, and that 2.15.0 ships an Experimental.V2 namespace. That namespace is the reason the version line matters: when OffchainState moves, this page breaks silently, and the caution is what tells a reader where to look.

All four linked URLs verified live (HTTP 200) on 2026-09-06. static/llms-full.txt regenerated so check-llms-txt passes.

Context

From the docs2 ↔ o1Labs overlap comparison indexed in #1237. o1Labs has no concept page for offchain storage — zkapps/provable-inputs is a 115-word stub — so this page stays canonical on Mina docs and is out of scope for the #1208 delegation. That is precisely why it needs to be kept current here rather than pointed elsewhere.

🤖 Generated with Claude Code

https://claude.ai/code/session_012A5LmAdLpUcPELjgHg3C5e

The prerequisites section told readers to "import `Experimental` from
o1js version 1.9.1 or higher". Current stable o1js is 2.15.0, so the
line is two major versions out of date and gives no signal about which
version the page was actually written against.

Checked against the library: `Experimental.OffchainState` and
`OffchainStateCommitments` are still exported in 2.15.0 and the usage
pattern on this page still matches. Only the version line was wrong.

- State 2.15.0 as the verified version instead of a stale floor.
- Link both symbols to their o1Labs API reference entries.
- Add a caution that the `Experimental` import path carries no stability
  guarantee, and that 2.15.0 ships an `Experimental.V2` namespace.

Refs #1230, #1208

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012A5LmAdLpUcPELjgHg3C5e
@vercel

vercel Bot commented Sep 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs2 Ready Ready Preview Sep 6, 2026 8:41pm UTC

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: offchain-storage still names o1js 1.9.1 — update to 2.15.0 and note the V2 namespace

1 participant