docs: align session/replay docs with shipped behavior; add YARD + agent-versioning guide#39
Merged
Conversation
…nt-versioning guide The previous docs and gemspec promised transparent session resume with a SQLite-backed event log. The SDK actually ships in-memory event buffering with replay via `subscribe_job(history: true, from_event_seq: ...)`, and the resume-token wiring is not finished. Update README, CONFORMANCE, architecture, recipes, and the sessions/resume/leases/jobs/troubleshooting guides to describe what we actually ship, and mark §6.3 transparent resume as deferred. Also add YARD-style docstrings to the public Client, Job::Handle, Lease, Runtime, EventLog, and AgentInventory surfaces, refresh the module-deps diagrams, and add a new agent-versioning guide. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
subscribe_job(history: true, from_event_seq: ...). Transparent session-resume wiring was promised but never finished, so README, CONFORMANCE, architecture, recipes, and the sessions/resume/leases/jobs/troubleshooting guides now describe the real behavior, and §6.3 transparent resume is marked deferred.Client,Job::Handle,Lease::*,Runtime,EventLog, andAgentInventorysurfaces.module-depsdiagrams to match the current dependency graph.docs/guides/agent-versioning.mdguide coveringregister_agentandname@versionresolution (spec §7.5).Why now
This came out of the doc audit pass — running through every guide against the live code surfaced the resume mismatch and several smaller wording drifts at the same time.
Test plan
rake yardparses the new docstrings without warningsrake docs:lint(or whatever the local docs check is) passesruntime.register_agent+submit_job(agent: 'name@version')actual behavior🤖 Generated with Claude Code