rivet-dev · NathanFlurry · Dec 5, 2025
diff --git a/.claude/resources/EXAMPLE_TEMPLATE.md b/.claude/resources/EXAMPLE_TEMPLATE.md
@@ -0,0 +1,68 @@
+# Example README Template
+
+All example READMEs in `/examples/` should follow this structure with exact section headings:
+
+```markdown
+<header with title and description>
+
+## Getting Started
+
+[Setup instructions - how to install dependencies and run the example]
+
+## Features
+
+[3-5 features that highlight what this example demonstrates, focusing on RivetKit concepts:]
+
+- Documents dashboard with pagination, drafts, groups, auto-revalidation
+- Collaborative whiteboard app with a fully-featured share menu
+- Authentication compatible with GitHub, Google, Auth0, and more
+- Document permissions can be scoped to users, groups, and the public
+
+## Prerequisites
+
+[Only include this section if there are non-obvious prerequisites like API keys or external services.
+Do not include obvious requirements like "Node.js" or "pnpm". For example:]
+
+- OpenAI API Key
+- PostgreSQL database
+
+## Implementation
+
+[Explain the key technical concepts, architecture, or implementation details. Always include GitHub
+source code links to key files. For example:]
+
+This example works by packaging your application code and uploading it to Freestyle.
+
+See the implementation in [`src/backend/registry.ts`](https://github.com/rivet-dev/rivet/tree/main/examples/example-name/src/backend/registry.ts).
+
+## Resources
+
+[Link to relevant RivetKit documentation that helps users understand the concepts demonstrated:]
+
+Read more about [actions](/docs/actors/actions) and [state](/docs/actors/state).
+
+## License
+
+[License info - typically MIT]
+```
+
+## Section Heading Convention
+
+Use these exact section headings (case-sensitive):
+- `## Getting Started` - Setup instructions
+- `## Features` - Feature list
+- `## Prerequisites` - Only if needed for non-obvious dependencies
+- `## Implementation` - Technical details (NOT "How it Works")
+- `## Resources` - Links to relevant documentation
+- `## License` - License info
+
+## Guidelines
+
+- **Features**: Focus on what RivetKit concepts the example demonstrates, not just what the app does. Highlight patterns like actor communication, state management, WebSocket handling, etc.
+- **Prerequisites**: Only include if the example requires non-obvious dependencies (API keys, external services). Skip obvious tooling like Node.js or pnpm.
+- **Implementation**: Always required. Explain the technical details and include GitHub source code links to key files.
+- **Resources**: Always include links to relevant RivetKit documentation that relates to the concepts in the example.
+- **Source Code Links**: Use GitHub links in the format: `https://github.com/rivet-dev/rivet/tree/main/examples/{example-name}/{path}`
+  - Example: `https://github.com/rivet-dev/rivet/tree/main/examples/ai-agent/src/backend/actors/agent.ts`
+- **Formatting**: Do not use em dashes (—). Use hyphens (-) or rephrase sentences instead.
+- Preserve existing header content (title, description) and license section.
diff --git a/.dockerignore b/.dockerignore
@@ -47,3 +47,7 @@ LICENSE*
 # Frontend
 !frontend/dist/
 
+# RivetKit packages (need pre-built dist for screenshot generation)
+!rivetkit-typescript/packages/*/dist/
+!engine/sdks/typescript/*/dist/
+
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -68,6 +68,10 @@ gt m
 
 - If you need to look at the documentation for a package, visit `https://docs.rs/{package-name}`. For example, serde docs live at https://docs.rs/serde/
 
+## Examples
+
+All example READMEs in `/examples/` should follow the format defined in `.claude/resources/EXAMPLE_TEMPLATE.md`.
+
 ## Architecture
 
 ### Monorepo Structure
@@ -184,3 +188,4 @@ Data structures often include:
 
 - When talking about "Rivet Actors" make sure to capitalize "Rivet Actor" as a proper noun and lowercase "actor" as a generic noun
 
+
diff --git a/examples/actor-actions/README.md b/examples/actor-actions/README.md
diff --git a/examples/quickstart-actions/package.json → examples/actor-actions/package.json b/examples/quickstart-actions/package.json → examples/actor-actions/package.json
diff --git a/...uickstart-actions/src/backend/registry.ts → ...les/actor-actions/src/backend/registry.ts b/...uickstart-actions/src/backend/registry.ts → ...les/actor-actions/src/backend/registry.ts
diff --git a/examples/counter/src/server.ts → examples/actor-actions/src/backend/server.ts b/examples/counter/src/server.ts → examples/actor-actions/src/backend/server.ts
diff --git a/...s/quickstart-actions/src/frontend/App.tsx → examples/actor-actions/src/frontend/App.tsx b/...s/quickstart-actions/src/frontend/App.tsx → examples/actor-actions/src/frontend/App.tsx
diff --git a/...uickstart-actions/src/frontend/index.html → ...les/actor-actions/src/frontend/index.html b/...uickstart-actions/src/frontend/index.html → ...les/actor-actions/src/frontend/index.html
diff --git a/.../quickstart-actions/src/frontend/main.tsx → examples/actor-actions/src/frontend/main.tsx b/.../quickstart-actions/src/frontend/main.tsx → examples/actor-actions/src/frontend/main.tsx
diff --git a/.../quickstart-actions/tests/actions.test.ts → examples/actor-actions/tests/actions.test.ts b/.../quickstart-actions/tests/actions.test.ts → examples/actor-actions/tests/actions.test.ts
diff --git a/examples/quickstart-actions/tsconfig.json → examples/actor-actions/tsconfig.json b/examples/quickstart-actions/tsconfig.json → examples/actor-actions/tsconfig.json
diff --git a/examples/counter-serverless/turbo.json → examples/actor-actions/turbo.json b/examples/counter-serverless/turbo.json → examples/actor-actions/turbo.json
diff --git a/...ickstart-native-websockets/vite.config.ts → examples/actor-actions/vite.config.ts b/...ickstart-native-websockets/vite.config.ts → examples/actor-actions/vite.config.ts
diff --git a/examples/quickstart-actions/vitest.config.ts → examples/actor-actions/vitest.config.ts b/examples/quickstart-actions/vitest.config.ts → examples/actor-actions/vitest.config.ts
diff --git a/examples/ai-agent/README.md b/examples/ai-agent/README.md
diff --git a/examples/ai-agent/package.json b/examples/ai-agent/package.json
diff --git a/examples/ai-agent/vite.config.ts b/examples/ai-agent/vite.config.ts
diff --git a/examples/ai-and-user-generated-actors-freestyle/README.md b/examples/ai-and-user-generated-actors-freestyle/README.md
diff --git a/examples/ai-and-user-generated-actors-freestyle/package.json b/examples/ai-and-user-generated-actors-freestyle/package.json
diff --git a/examples/counter/turbo.json → ...ser-generated-actors-freestyle/turbo.json b/examples/counter/turbo.json → ...ser-generated-actors-freestyle/turbo.json
diff --git a/examples/counter-next-js/.gitignore → examples/chat-room-next-js/.gitignore b/examples/counter-next-js/.gitignore → examples/chat-room-next-js/.gitignore
diff --git a/examples/chat-room-next-js/README.md b/examples/chat-room-next-js/README.md
diff --git a/examples/counter-next-js/next.config.ts → examples/chat-room-next-js/next.config.ts b/examples/counter-next-js/next.config.ts → examples/chat-room-next-js/next.config.ts