Skip to content

docs: reconcile current release and playback references - #319

Merged
timeleft-- merged 3 commits into
mainfrom
codex/docs136-closeout
Oct 27, 2026
Merged

timeleft-- merged 3 commits into
mainfrom
codex/docs136-closeout

Conversation

@timeleft--

Copy link
Copy Markdown
Member

Current reference pages still described private, unversioned or five-package SDK releases, absent starters and React limited to early qualification slices. Align those summaries with the seven public packages, implemented React/Lit composition, maintained source templates and actual candidate install sets. Release preparation now distinguishes the Node 22.23.3 source-tooling minimum from the packages' Node 22.12.0 requirement and explains why qualification uses reviewed sibling tarballs even when registry versions exist.

The playback guide now follows the current action work deadline, separate hook budgets, transferred player ownership and unified teardown/disposal path. Publication handoff command forms use the source CLI. Historical observations and host acceptance limits remain scoped; no runtime, package version, publication or deployment changes are included.

Validation: 125 documentation/consumer-boundary tests passed; formatter hooks verified; version policy passed with all seven versions unchanged; 20 LFS pointers valid; local documentation targets checked (inline illustrative Markdown excluded). Source claims checked against the merged source at c2e54ff and the current package manifests, candidate/consumer tooling, playback controller and view lifetime runner. Runtime/host suites were not repeated for these prose corrections.

Merge when clean: yes

@yia-mw-agent yia-mw-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Helmet-Review-Request: #319 (comment)

APPROVE at abb0d4f. I found no material defects.

Scope: the full merge-base-to-head diff against main (merge-base c2e54ff), 5 documentation files, 3 commits. The task was queued at 574ba1b. The head moved to d9eb3a5 and then to abb0d4f while the review was pending. I reviewed the whole PR at abb0d4f, including the delta commits, and the head was still abb0d4f when I submitted.

Checked against source at that head:

  • Seven public packages and the Node floors. All seven manifests are non-private at 0.7.7-rc.1 with engines node >=22.12.0. The root package.json engines and .nvmrc are 22.23.3. This supports the Node wording in release-packages.md and development-reference.md. public-install.md agrees that all seven are published.
  • Package READMEs. packages/*/README.md exists for all seven, so "all seven packages also carry a package README" holds.
  • Candidate own and card package sets. PACK1_CONSUMERS in scripts/build-pack1-consumers.ts installs core, lit, components, mcp and lit-mcp-stack for both. combinationRecords takes its packages from that. The candidate-update and rollback guide matches.
  • Playback guide. The 30,000 ms work deadline and 5,000 ms hook budget match packages/core/src/actions/limits.ts. The lease transfer after a confirmed start matches playback-view.ts (held.transfer(owner.retain)). The end-of-playback sentence matches player-owner.ts and owner.onEnded: natural end marks the lease ended and shows ended, and the lease is released on a new Play (begin→stopAll), label loss, or teardown. The lifetime-runner sentences match run-tool-result-view.ts: one end(), onTeardown once, host answered first, and dispose() and pagehide share the path.
  • Publish handoff commands use npx tsx scripts/saga.ts publish handoff ..., consistent with the source CLI.
  • Local links in the changed text resolve.

Validation: npm ci and npm run test:docs ran at abb0d4f: 4 files, 125 tests passed. GitHub checks on the PR: documentation and policy, version policy and GitBook succeeded; the application build job was skipped, which is expected for a docs-only diff. No runtime, version or package changes are in the diff.

Non-blocking:

  • candidate-update-and-rollback.md, application-owned files table: "the card variant also uses Lit FaithfulCard and components entries". main-card.ts actually imports @saga-a2ui/components/faithful-card and @saga-a2ui/lit-mcp-stack/faithful-card. Naming those two entries would be more exact.
  • The playback guide still says the view-state diagram predates the unknown-outcome wording. That was already in the guide, and the PR leaves it as is.

@timeleft--
timeleft-- merged commit 77a7623 into main Oct 27, 2026
4 checks passed
@timeleft--
timeleft-- deleted the codex/docs136-closeout branch October 27, 2026 14:36
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