Skip to content

docs: document how to check the GramFrame version#182

Merged
IanMayo merged 1 commit into
mainfrom
claude/document-version-check
Jun 26, 2026
Merged

docs: document how to check the GramFrame version#182
IanMayo merged 1 commit into
mainfrom
claude/document-version-check

Conversation

@IanMayo

@IanMayo IanMayo commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #181, which added a way to read a GramFrame instance's version (Pan button tooltip + a single getVersion() source of truth). That capability wasn't documented anywhere — this adds a short "Checking the version" section to the README.

What it covers

  • UI route: hover the Pan button to see GramFrame vX.Y.Z (works even while the button is disabled, before zooming in).
  • Programmatic route: read state.version via the public GramFrame.addStateListener(...) API. (There's no dedicated getVersion() method on the public API — the state listener is the only public path, so that's what's documented.)
  • A note that released builds show the real version while dev builds show vDEV until yarn generate-version runs.

Documentation-only change; no code touched.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UrV8WBAsULghxpC6j7d9J5


Generated by Claude Code

Adds a "Checking the version" section to the README covering both the Pan
button tooltip and the programmatic state.version route via the public API.

Co-Authored-By: Claude Opus 4.8 <[email protected]>
Claude-Session: https://claude.ai/code/session_01UrV8WBAsULghxpC6j7d9J5
@IanMayo IanMayo merged commit dc56aae into main Jun 26, 2026
3 of 4 checks passed
@IanMayo IanMayo deleted the claude/document-version-check branch June 26, 2026 09:45
@github-actions

Copy link
Copy Markdown
Contributor

PR Preview

Preview deployment is ready! View Preview

Last updated: 2026-06-26T09:45:22.704Z

github-actions Bot added a commit that referenced this pull request Jun 26, 2026
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.

2 participants