Skip to content

docs: add install step, migration note, and typed try example - #15

Open
jog1t wants to merge 1 commit into
mainfrom
docs/install-and-migration
Open

jog1t wants to merge 1 commit into
mainfrom
docs/install-and-migration

Conversation

@jog1t

@jog1t jog1t commented Sep 18, 2026

Copy link
Copy Markdown
  • Quickstart: add an ## Install section (npm install @rivet-dev/workflows) and note that the package re-exports RivetKit, so setup, actor and queue share the import while clients keep rivetkit/client.
  • Introduction: name workflow({...}) and @rivet-dev/workflows, and add a migration note from rivetkit/workflow (actor({ run: workflow(...) })). History encoding is unchanged (per the README and tests/compat/upgrade.test.ts).
  • Steps: replace the untyped inline ctx.try block with examples/docs/actors-workflows/try-block.ts, a typed workflow({...}) plus setup registry.

pnpm check-types passes; biome check examples/docs is clean.

@the-company-company the-company-company Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found

Reviewed commit 873fc0b.

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