feat(site): auto-generate templates from examples dir

[NathanFlurry]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
rivet-inspector	Ready	Preview	Comment	Dec 8, 2025 9:51pm
rivet-site	Ready	Preview	Comment	Dec 8, 2025 9:51pm
rivetkit-serverless	Error			Dec 8, 2025 9:51pm

1 Skipped Deployment

Project	Deployment	Preview	Comments	Updated (UTC)
rivet-cloud	Ignored			Dec 8, 2025 9:51pm

[NathanFlurry]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• feat(site): auto-generate templates from examples dir #3603 👈 (View in Graphite)
• feat(site): add templates #3567
• feat(examples): add user-generated-actors example #3560
• feat(frontend): create api key #3556
• fix(frontend): do not show tokens button if not on namespace page #3558
• fix(frontend): update env vars for dev #3557
• docs: clean up last few missing pieces of content #3538
• main

---

How to use the Graphite Merge Queue

Add the label merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[pkg-pr-new]

More templates

• actor-actions
• example-ai-agent
• example-ai-and-user-generated-actors-freestyle
• chat-room
• chat-room-next-js
• example-cloudflare-workers
• example-cloudflare-workers-hono
• example-cloudflare-workers-inline-client
• cross-actor-actions
• example-cursors
• example-cursors-raw-websocket
• custom-serverless
• example-deno
• example-sqlite
• example-elysia
• example-express
• example-hono
• hono-bun
• hono-react
• example-kitchen-sink
• multi-region
• native-websockets
• next-js
• node
• example-raw-fetch-handler
• example-raw-websocket-handler
• example-raw-websocket-handler-proxy
• example-react
• scheduling
• state
• example-stream
• example-trpc

@rivetkit/cloudflare-workers

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/cloudflare-workers@3603

@rivetkit/db

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/db@3603

@rivetkit/framework-base

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/framework-base@3603

@rivetkit/next-js

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/next-js@3603

@rivetkit/react

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/react@3603

rivetkit

pnpm add https://pkg.pr.new/rivet-dev/rivet/rivetkit@3603

@rivetkit/sql-loader

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/sql-loader@3603

@rivetkit/engine-runner

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner@3603

@rivetkit/engine-runner-protocol

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner-protocol@3603

commit: c15b145

[claude]

PR Review: Auto-generate templates from examples directory

Summary

This PR refactors the examples directory to auto-generate templates, including renaming examples, standardizing READMEs, updating package.json metadata, and removing obsolete counter examples. The overall approach is solid and improves consistency across examples.

---

✅ Code Quality & Best Practices

Strengths:

• Consistent structure: All README files now follow a uniform format with standardized "Getting Started" sections
• Metadata standardization: Package.json files include template metadata with priority, frontendPort, and noFrontend fields for better organization
• License consistency: All examples now use MIT license
• Cleanup: Removed obsolete examples (counter, counter-next-js, counter-serverless, quickstart-actions, quickstart-native-websockets)
• File organization: Examples renamed for clarity (e.g., quickstart-actions → actor-actions)

Observations:

• Vite config changes add host: "0.0.0.0" consistently across examples - good for Docker/container compatibility
• Docker ignore updates properly include dist directories for RivetKit packages needed for screenshot generation

---

⚠️ Potential Issues

1. Missing README description context (Minor)

The new READMEs are very minimal. While consistent, they might be too brief for users unfamiliar with the concepts. For example:

# Actor Actions

Demonstrates how to define and call actions on Rivet Actors for RPC-style communication between actors and clients.

Consideration: Previous READMEs included more context about features and usage patterns. The new versions assume users already understand what they're doing.

2. Dependency version inconsistency (Minor)

In examples/ai-and-user-generated-actors-freestyle/package.json:

"@rivetkit/engine-api-full": "latest"

Issue: Using "latest" instead of workspace dependency or pinned version can lead to version mismatches and unexpected behavior.

Recommendation: Use "workspace:*" or a specific version for consistency with other packages.

3. Removed CLI functionality documentation (Minor)

In examples/chat-room/README.md, the CLI interface instructions were removed:

-#### CLI Interface
-
-Alternatively, use the CLI interface:
-
-```sh
-npm run dev:cli
-```

Question: Does the CLI functionality still exist? If so, this information should be retained.

4. Large CSS file added (Minor)

examples/chat-room-next-js/src/app/globals.css adds 463 lines of CSS. While functional, consider:

• Is this duplicated from the non-Next.js chat-room example?
• Could it be shared or imported to maintain DRY principles?

5. Metadata field validation (Minor)

Template metadata includes fields like:

• priority: Numbers ranging from 100-1000
• frontendPort: Port numbers (3000, 5173, etc.)
• noFrontend: Boolean flag

Question: Is there documentation or schema validation for these fields? Inconsistent values could cause issues in template generation.

---

🔒 Security Concerns

No critical security issues identified. The changes are primarily organizational and documentation-focused.

Observations:

• Vite config changes to bind to 0.0.0.0 are appropriate for containerized environments
• No sensitive data, credentials, or unsafe operations introduced
• Dependency changes use workspace references (secure practice)

---

🧪 Test Coverage

Observations:

• Test files remain unchanged in moved examples (e.g., actor-actions/tests/actions.test.ts)
• No new tests added or existing tests modified
• Package.json scripts maintain existing test commands

Recommendation: Verify that tests still pass after the reorganization, especially for renamed examples.

---

📋 Additional Recommendations

1. Documentation: Consider adding a TEMPLATES.md or updating main README to explain:

   • The template metadata schema
   • How priority values affect ordering
   • What each metadata field controls

2. Version consistency: Replace "latest" dependency with workspace reference in ai-and-user-generated-actors-freestyle/package.json

3. Verify removed examples: Ensure no external documentation or links reference the deleted examples:

   • counter
   • counter-next-js
   • counter-serverless
   • quickstart-actions
   • quickstart-native-websockets

4. Test the changes: Run a full test suite to ensure:

   • All examples build successfully
   • Template generation works as expected
   • Screenshot generation functions with the new Docker ignore rules

---

✨ Conclusion

This is a well-structured refactoring that improves consistency across examples. The issues identified are minor and mostly relate to documentation completeness and version management. The code changes are safe and follow good practices.

Recommendation: Approve with minor suggestions to address the dependency version issue and verify test coverage.

---

Reviewed by Claude Code 🤖