You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clean up separation between actors/containers/functions (#2394)
<!-- Please make sure there is an issue that this PR is correlated to. -->
## Changes
<!-- If there are frontend changes, please include screenshots. -->
Copy file name to clipboardExpand all lines: site/src/content/docs/actors.mdx
+22-17Lines changed: 22 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,21 @@
1
-
# JavaScript Runtime
1
+
# Rivet Actors
2
2
3
-
The Rivet JavaScript runtime is built on lightweight JavaScript containers called V8 isolates, providing a high-performance, secure environment for your actor code.
4
-
5
-
It's designed to be widely compatible with Node.js and NPM dependencies, making it easy to use familiar libraries and tools.
3
+
Rivet Actors allows you to deploy resilient, stateful services that maintain their state between requests. Use them for websocket servers, game backends, real-time collaboration services, and more.
6
4
7
5
<Tiptitle="Get Started Faster With ActorCore">
8
6
For getting started quickly using JavaScript, we recommend trying [ActorCore](https://actorcore.org) – our full-stack framework for working with Rivet Actors.
9
7
</Tip>
10
8
11
-
## Basic Setup
9
+
## What are actors good for?
10
+
11
+
-**Stateful Services**: Applications where maintaining state across interactions is critical. For example, **Collaborative Apps** with shared editing and automatic persistence.
12
+
-**Realtime Systems**: Applications requiring fast, in-memory state modifications or push updates to connected clients. For example, **Multiplayer Games** with game rooms and player state.
13
+
-**Long-Running Processes**: Tasks that execute over extended periods or in multiple steps. For example, **AI Agents** with ongoing conversations and stateful tool calls.
14
+
-**Durability**: Processes that must survive crashes and restarts without data loss. For example, **Durable Execution** workflows that continue after system restarts.
15
+
-**Horizontal Scalability**: Systems that need to scale by distributing load across many instances. For example, **Realtime Stream Processing** for stateful event handling.
16
+
-**Local-First Architecture**: Systems that synchronize state between offline clients. For example, **Local-First Sync** between devices.
17
+
18
+
## Quickstart
12
19
13
20
### Step 1: Writing an actor
14
21
@@ -26,22 +33,20 @@ Every actor must export a default object with an async `start` function. Here's
0 commit comments