Skip to content

docs: refresh README and CLAUDE.md after recent worker/store updates - #40

Merged
myzie merged 1 commit into
mainfrom
docs/post-pr39-refresh
Apr 13, 2026
Merged

docs: refresh README and CLAUDE.md after recent worker/store updates#40
myzie merged 1 commit into
mainfrom
docs/post-pr39-refresh

Conversation

@myzie

@myzie myzie commented Apr 13, 2026

Copy link
Copy Markdown
Contributor

Summary

What's reflected

  • Claim now carries WorkerID, ProjectID, ParentRunID, InitiatedBy, and Metadata.
  • *HandlerContext with the only-Checkpointer-is-lease-fenced caveat; SignalStore lives on Config.
  • New experimental/worker/runquery/ subpackage as the backend-neutral run query API.
  • Postgres WithSchema(...) for configurable schema namespace, with Migrate issuing CREATE SCHEMA IF NOT EXISTS.
  • Atomic DeleteRun that refuses running runs.
  • v0.0.3 → v0.0.4 single-tenant upgrade carry-forward (empty org_id/initiated_by rewritten to NULL).
  • SQLite coexistence note (no schema namespacing — pass a dedicated *sql.DB).
  • Postgres read-side Run API (GetRun, ListRuns, CountRuns, DeleteRun).

Test plan

  • Skim the rendered README on the PR page to confirm tone and links land
  • Verify referenced doc paths still exist (docs/worker.md, docs/postgres.md, docs/suspension.md, documentation/, examples/signal_wait, examples/durable_sleep, examples/pause_unpause)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified library positioning as a pure in-process execution engine for multi-step workflows with suspend/resume capability
    • Emphasized storage, queues, and infrastructure are consumer responsibilities
    • Expanded descriptions of experimental worker, postgres store, and sqlite store modules
    • Refined guidance comparing Runner (convenience wrapper) vs Execute (direct execution)

Reflect the changes from PRs #37-#39: richer Claim fields, HandlerContext
with the only-Checkpointer-is-fenced caveat, the runquery subpackage,
configurable Postgres schema via WithSchema, atomic DeleteRun, the
v0.0.3 single-tenant upgrade carry-forward, and the SQLite coexistence
note. Lighter tone throughout; replaced the "Going to production"
section with a friendlier "Bring your own storage" framing.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Apr 13, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 410aabc3-1bf7-452e-b24c-f9b3555bc4d3

📥 Commits

Reviewing files that changed from the base of the PR and between 8d39f63 and 2a29a65.

📒 Files selected for processing (2)
  • CLAUDE.md
  • README.md

📝 Walkthrough

Walkthrough

Documentation updates reframing the library as a pure in-process execution engine, clarifying consumer responsibilities for external storage/infrastructure implementation, and expanding descriptions of experimental submodules including new runquery APIs and storage implementations.

Changes

Cohort / File(s) Summary
Documentation Repositioning
CLAUDE.md
Reframed library as in-process execution engine; clarified consumer-supplied storage/infra patterns; revised experimental module descriptions (worker handler API, lease-fencing semantics); added experimental/worker/runquery/ submodule section; expanded experimental/store/postgres/ and experimental/store/sqlite/ details including pagination, migration behavior, and schema requirements.
README Execution Model Clarification
README.md
Updated execution engine positioning and "ability to suspend and resume" language; reframed Runner as convenience wrapper rather than production requirement; replaced "Going to production" section with "Bring your own storage" guidance; added experimental submodule capability descriptions (claim/credit reconciliation, runquery APIs); reorganized reference links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 A rabbit's ode to clearer docs,
Where execution flows like garden stocks—
In-process pure, let consumers own,
The storage seeds they're free to sown! 🌱

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/post-pr39-refresh

Comment @coderabbitai help to get the list of available commands and usage tips.

@myzie
myzie merged commit 46f649f into main Apr 13, 2026
1 of 2 checks passed
@myzie
myzie deleted the docs/post-pr39-refresh branch April 13, 2026 02:04
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.

1 participant