Skip to content

fix(website): point workflow references at @rivet-dev/workflows - #72

Merged
jog1t merged 2 commits into
rivet-dev:mainfrom
jog1t:docs/workflows-package-refs
Sep 24, 2026
Merged

jog1t merged 2 commits into
rivet-dev:mainfrom
jog1t:docs/workflows-package-refs

Conversation

@jog1t

@jog1t jog1t commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Workflows moved from `rivetkit/workflow` to the standalone `@rivet-dev/workflows` package. This updates the website-owned references.

  • `/workflows`: the `invoice.ts` hero example was read from the actors docs root. That copy still used the old `actor({ run: workflow(...) })` API, right next to an `npm install @rivet-dev/workflows` button. The example now comes from the workflows docs root, and the GitHub source and example links point at `rivet-dev/workflows`.
  • `/agentos`: the workflows code tab uses `workflow({...})` from `@rivet-dev/workflows`.
  • The "Every workflow is an Actor run handler" copy (`/workflows`, `/actors`) and the Workflows FAQ now describe `workflow({...})` as the actor definition. The FAQ's GitHub link points at the new repo.
  • In the agent setup prompt, the Workflows `issuesUrl` is now `rivet-dev/workflows/issues`.
  • Deleted the unreferenced `src/data/use-cases.ts` and the stale "workflows docs unwritten" row in `HIDDEN.md`.

The vendored actors, agentOS, and Dynamic Apps docs still carry old snippets until they are re-synced from the product repos. The actors fix is rivet-dev/rivet#5752.

Checked on a local dev server: `/workflows`, `/actors`, and `/agentos` contain no `rivetkit/workflow` references.

The /workflows hero example loaded the old rivetkit/workflow snippet from the
actors docs root; it now reads the workflows docs root. GitHub links, FAQ copy,
the agentOS code tab, and the agent setup issues URL move to the standalone
package.

@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.

🟠 1 medium-severity finding

Reviewed commit 09d6ae3.

Comment thread src/pages/agentos.astro
…e-refs

# Conflicts:
#	HIDDEN.md
#	src/data/agentSetupPrompt.ts
#	src/pages/actors.astro
#	src/pages/workflows.astro

@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.

🟠 1 medium-severity finding

Reviewed commit 788e5b9.

Comment thread src/pages/agentos.astro
import pi from "@agentos-software/pi";
import { actor, queue } from "rivetkit";
import { workflow } from "rivetkit/workflow";
import { queue, workflow } from "@rivet-dev/workflows";

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟠 Medium · The combined agentOS workflow example still does not type-check

The dependency mismatch remains on the refreshed head: current agentOS still pins rivetkit@2.3.10, while @rivet-dev/workflows requires >=2.3.11 <2.4.0. A clean install therefore loads two nominally incompatible RivetKit Registry/ActorDefinition classes, and this snippet fails at step.client<typeof registry>() with TS2344 because the private class members come from different copies. Land and release the agentOS dependency fix before publishing this example, or keep the example off the page until the packages can be installed together.

@jog1t
jog1t merged commit 42d7c64 into rivet-dev:main Sep 24, 2026
2 of 3 checks passed
@jog1t
jog1t deleted the docs/workflows-package-refs branch September 24, 2026 19:12
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