Skip to content

docs: update CLAUDE.md and README.md for post-v1 accuracy - #36

Merged
myzie merged 1 commit into
mainfrom
docs/post-v1-updates
Apr 12, 2026
Merged

docs: update CLAUDE.md and README.md for post-v1 accuracy#36
myzie merged 1 commit into
mainfrom
docs/post-v1-updates

Conversation

@myzie

@myzie myzie commented Apr 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • CLAUDE.md: Fix stale Path→Branch terminology throughout, add missing interfaces (SignalStore, WorkflowRegistry) to scope section, add suspend/sleep/pause to "Does" list, update activity tier descriptions (stable/contrib/httpx split), add experimental submodules (worker, postgres, sqlite), add documentation/ user guides reference, fix frozen-signature conventions (Execute()/functional options instead of removed Run()/Resume()), update WithScriptCompiler() reference
  • README.md: Add documentation/ user guides to Reference section, add experimental/store/sqlite/ alongside existing worker and postgres mentions

Test plan

  • Verify all referenced paths exist (documentation/, experimental/worker/, experimental/store/postgres/, experimental/store/sqlite/)
  • Confirm terminology matches current codebase (Branch, not Path)
  • Confirm interface names match exports (SignalStore, WorkflowRegistry, BranchMappings)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated execution semantics documentation with clarifications on suspension handling, branching model, and concurrency patterns.
    • Expanded module layout documentation and added references to new experimental submodules.
    • Added documentation directory reference with coverage areas.
    • Generalized persistence backend guidance in production setup section.

Align docs with the v1 API surface after recent PRs (#14, #33, #34):
Path→Branch terminology, activity tier split, experimental submodules,
frozen-signature conventions, missing interfaces, and user guide links.

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

coderabbitai Bot commented Apr 12, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5f8e5db2-1b9c-4eb9-b2ab-da7acabe8057

📥 Commits

Reviewing files that changed from the base of the PR and between b73b403 and 5b10a90.

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

📝 Walkthrough

Walkthrough

Documentation updates describe the library's execution semantics, module organization, and consumer interfaces. Changes include replacing "Path" terminology with "Branch," adding SignalStore and WorkflowRegistry interfaces, clarifying built-in activities, and documenting experimental submodules including SQLite support. No code changes are involved.

Changes

Cohort / File(s) Summary
Documentation Updates
CLAUDE.md, README.md
Updated library documentation to reflect execution semantics (branch terminology replacing path), expanded consumer-provided interfaces (SignalStore, WorkflowRegistry), clarified DefaultScriptCompiler usage via options, reorganized built-in activities descriptions, and documented experimental submodules (worker, postgres, sqlite backends).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Documentation dances in the spring air,
Branches replace paths with elegant care,
New stores and workers, all labeled with care,
SQLite joins postgres in the experimental lair,
thump thump — clarity blooms everywhere!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the primary change: documentation updates to CLAUDE.md and README.md for post-v1 accuracy. It is concise, specific, and directly reflects the changeset's main purpose.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

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

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

@myzie
myzie merged commit b0300aa into main Apr 12, 2026
2 checks passed
@myzie
myzie deleted the docs/post-v1-updates branch April 12, 2026 18:38
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