docs: clean up separation between actors/containers/functions #2394

NathanFlurry · 2025-04-25T16:14:01Z

Changes

NathanFlurry · 2025-04-25T16:14:21Z

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

docs: clean up separation between actors/containers/functions #2394 👈 (View in Graphite)
chore: fix building hub archive #2368
feat(hub): logs #2364
feat: routes #2365
chore: fix paths to sandboxed code execution examples #2381
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.

graphite-app · 2025-04-25T16:14:25Z

Merge activity

Apr 25, 12:14 PM EDT: NathanFlurry added this pull request to the Graphite merge queue.
Apr 25, 12:15 PM EDT: CI is running for this pull request on a draft pull request (#2395) due to your merge queue CI optimization settings.
Apr 25, 12:16 PM EDT: Merged by the Graphite merge queue via draft PR: #2395.

## Changes

greptile-apps

PR Summary

This PR reorganizes the documentation to establish clearer distinctions between Rivet's three main components: Actors, Containers, and Functions.

Added new /docs/functions.mdx introducing serverless function capabilities with configuration and routing details
Updated site/_redirects to map legacy runtime URLs to their new counterparts (/docs/javascript-runtime → /docs/actors, /docs/container-runtime → /docs/containers)
Added route-related API documentation in /site/src/content/docs/api/routes/ for list, update, and delete operations
Modified generateApi.js to include routes-related API endpoints in documentation generation
Renamed and restructured documentation files to use consistent terminology across actors, containers, and functions

_{15 file(s) reviewed, 8 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-04-25T16:14:37Z

frontend/packages/components/src/actors/get-started.tsx

+					/>
+					<ExampleLink
+						href="docs/functions"
+						title="Rivet Functions"
 						size="md"
 						icon={faTs}


logic: using faTs icon for Functions section seems incorrect - should use faFunction icon instead

greptile-apps · 2025-04-25T16:14:37Z

frontend/packages/components/src/actors/get-started.tsx

 					<ExampleLink
-						href="docs/quickstart/typescript"
-						title="TypeScript"
+						href="docs/actors"
+						title="Rivet Actors"
+						size="md"
+						icon={faActors}
+					/>
+					<ExampleLink
+						href="docs/containers"
+						title="Rivet Containers"
+						size="md"
+						icon={faServer}
+					/>
+					<ExampleLink
+						href="docs/functions"
+						title="Rivet Functions"
 						size="md"
 						icon={faTs}
 					/>


style: grid layout with 3 items in 2 columns will result in uneven distribution - consider adjusting grid-cols-2 to grid-cols-3 or grid-cols-1

greptile-apps · 2025-04-25T16:15:05Z

site/src/content/docs/api/routes/delete.mdx

+await RIVET.routes.delete({
+  // Add your request body here
+});


logic: Example code is missing required 'id' parameter which is marked as required in schema

Suggested change

await RIVET.routes.delete({

// Add your request body here

});

await RIVET.routes.delete({

id: "route-id", // Required: The ID of the route to delete

});

greptile-apps · 2025-04-25T16:15:07Z

site/src/content/docs/api/routes/list.mdx

+
+// Make request
+await RIVET.routes.list({
+  // Add your request body here


logic: Example request body should be removed since this GET endpoint doesn't accept a request body

Suggested change

// Add your request body here

// Optional query parameters: project, environment

greptile-apps · 2025-04-25T16:15:08Z

site/src/content/docs/actors.mdx


 export default {
  async start(ctx: ActorContext) {
-    // Get the port from environment variables or use a default
-    const port = parseInt(process.env.PORT_HTTP || "8080");
+    const port = parseInt(Deno.env.get("PORT_HTTP") || "8080");


logic: Using Deno.env.get() but npm installing @rivet-gg/actor - need to clarify if this is a Deno or Node.js environment

greptile-apps · 2025-04-25T16:15:08Z

site/src/content/docs/api/routes/list.mdx

+<CodeGroup title='Request' tag='GET' label='https://api.rivet.gg/routes'>
+
+```bash {{ "title": "cURL" }}
+curl -X GET 'https://api.rivet.gg/routes'


style: Missing project and environment query parameters in cURL example

greptile-apps · 2025-04-25T16:15:45Z

site/src/content/docs/functions.mdx

+| `path` | The URL path to route requests to (cannot end with `/`) |
+| `route_subpaths` | When true, routes requests to this path and all nested subpaths to this function |
+| `strip_prefix` | When true, removes the configured path prefix from the request URL before forwarding to your function |
+| `resources.cpu` | CPU allocation for the function (defaults to 1) |


logic: CPU value of 1 is ambiguous - should clarify if this means 1 core (1000 millicores) or 1 millicore

greptile-apps · 2025-04-25T16:15:46Z

site/src/content/docs/functions.mdx

+const { Hono } = require('hono');
+const { serve } = require('hono/node-server');
+const app = new Hono();
+const port = process.env.PORT_HTTP || 8080;


style: PORT_HTTP environment variable usage should be consistent with networking.internal_port config option mentioned later

docs: clean up separation between actors/containers/functions

6e38203

This was referenced Apr 25, 2025

chore: fix building hub archive #2368

Closed

feat(hub): logs #2364

Closed

feat: routes #2365

Closed

NathanFlurry mentioned this pull request Apr 25, 2025

chore: fix paths to sandboxed code execution examples #2381

Closed

graphite-app bot closed this Apr 25, 2025

graphite-app bot deleted the 04-25-docs_clean_up_separation_between_actors_containers_functions branch April 25, 2025 16:16

greptile-apps bot reviewed Apr 25, 2025

View reviewed changes

github-actions bot mentioned this pull request Apr 26, 2025

chore(main): release 25.4.0 #2402

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: clean up separation between actors/containers/functions #2394

docs: clean up separation between actors/containers/functions #2394

Uh oh!

NathanFlurry commented Apr 25, 2025

Uh oh!

NathanFlurry commented Apr 25, 2025 •

edited

Loading

Uh oh!

graphite-app bot commented Apr 25, 2025 •

edited

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

greptile-apps bot Apr 25, 2025

Uh oh!

Uh oh!

	// Add your request body here
	// Optional query parameters: project, environment

docs: clean up separation between actors/containers/functions #2394

docs: clean up separation between actors/containers/functions #2394

Uh oh!

Conversation

NathanFlurry commented Apr 25, 2025

Changes

Uh oh!

NathanFlurry commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

graphite-app bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NathanFlurry commented Apr 25, 2025 •

edited

Loading

graphite-app bot commented Apr 25, 2025 •

edited

Loading