Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 1 addition & 23 deletions docs/concepts/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Overview
title: Introduction
icon: square-info
---

Expand All @@ -13,28 +13,6 @@ Run this to get started:

<CreateActorCli />

## What are actors good for?

Actors in ActorCore are ideal for applications requiring:

- **Stateful Services**: Applications where maintaining state across interactions is critical. For example, **Collaborative Apps** with shared editing and automatic persistence.
- **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.
- **Long-Running Processes**: Tasks that execute over extended periods or in multiple steps. For example, **AI Agents** with ongoing conversations and stateful tool calls.
- **Durability**: Processes that must survive crashes and restarts without data loss. For example, **Durable Execution** workflows that continue after system restarts.
- **Horizontal Scalability**: Systems that need to scale by distributing load across many instances. For example, **Realtime Stream Processing** for stateful event handling.
- **Local-First Architecture**: Systems that synchronize state between offline clients. For example, **Local-First Sync** between devices.

## Core Concepts

In ActorCore, each actor has these key characteristics:

- **State Is Automatically Persisted**: State automatically persists between restarts, upgrades, & crashes
- **State Is Stored In-Memory**: State is stored in memory for high-performance reads/writes while also automatically persisted
- **Isolated State Ownership**: Actors only manage their own state, which can only be modified by the actor itself
- **Communicates via Actions**: How clients and other actors interact with an actor
- **Actions Are Low-Latency**: Actions provide WebSocket-like performance for time-sensitive operations
- **Broadcast Updates With Events**: Actors can publish real-time updates to connected clients

## Code Example

Here's a complete chat room actor that maintains state and handles messages. We'll explore each component in depth throughout this document:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://mintlify.com/docs.json",
"name": "ActorCore",
"description": "Stateful, scalable, realtime backend framework. The modern way to build multiplayer, realtime, or AI agent backends. Supports Rivet, Cloudflare Workers, Bun, and Node.js.",
"description": "Stateful Serverless that runs anywhere. The easiest way to build stateful, AI agent, collaborative, or local-first applications.",
"theme": "palm",
"logo": {
"dark": "/logo/dark.svg",
Expand Down
20 changes: 20 additions & 0 deletions docs/images/clients/nextjs.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions docs/images/clients/python.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/images/integrations/better-auth.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
13 changes: 13 additions & 0 deletions docs/images/integrations/livestore.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/images/integrations/resend.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/images/integrations/tinybase.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading