From 5d98900f66d007fca1ead46e1a830bf0dfd02934 Mon Sep 17 00:00:00 2001 From: Nathan Flurry Date: Thu, 25 Jun 2026 15:45:12 -0700 Subject: [PATCH] docs(website): add quickstart Deploy step + standardize deploy cards & nav - Add a Deploy step (step 5) to the quickstart - Add a reusable DeployTargets.astro card grid, shared by the quickstart and the deploy page so they can't drift - Compact deploy cards (icon + title, no descriptions) - Marketing nav: Documentation, Use Cases, Registry, Deploy (plain links) - Standardize docs top-nav to match the marketing nav order/labels --- website/docs.config.mjs | 5 +- website/src/components/DeployTargets.astro | 40 ++++++++++++++++ website/src/components/Navigation.tsx | 3 +- website/src/content/docs/docs/deployment.mdx | 50 ++------------------ website/src/content/docs/docs/quickstart.mdx | 9 ++++ 5 files changed, 58 insertions(+), 49 deletions(-) create mode 100644 website/src/components/DeployTargets.astro diff --git a/website/docs.config.mjs b/website/docs.config.mjs index 61f3a2e9ec..37b0649f58 100644 --- a/website/docs.config.mjs +++ b/website/docs.config.mjs @@ -18,10 +18,13 @@ export const siteConfig = { repo: "rivet-dev/agent-os", editPath: "website/", + // Keep in sync with the marketing nav (src/components/Navigation.tsx): + // same links in the same order across docs + marketing. topNav: [ + { label: "Documentation", href: "/docs", match: "/docs" }, { label: "Use Cases", href: "/use-cases" }, { label: "Registry", href: "/registry" }, - { label: "Docs", href: "/docs", match: "/docs" }, + { label: "Deploy", href: "/docs/deployment", match: "/docs/deployment" }, ], cta: { label: "Get Started", href: "/docs/quickstart" }, social: { discord: "https://rivet.dev/discord" }, diff --git a/website/src/components/DeployTargets.astro b/website/src/components/DeployTargets.astro new file mode 100644 index 0000000000..b4606966d2 --- /dev/null +++ b/website/src/components/DeployTargets.astro @@ -0,0 +1,40 @@ +--- +--- +
+ + +
Rivet Compute
+ + + +
Vercel
+ + + +
Railway
+ + + +
Kubernetes
+ + + +
AWS ECS
+ + + +
Google Cloud Run
+ + + +
Hetzner
+ + + +
VM & Bare Metal
+ + + +
Custom Platform
+ +
diff --git a/website/src/components/Navigation.tsx b/website/src/components/Navigation.tsx index eb1c2756cb..df78e8ca5c 100644 --- a/website/src/components/Navigation.tsx +++ b/website/src/components/Navigation.tsx @@ -20,9 +20,10 @@ function DiscordIcon({ className }: { className?: string }) { } const NAV_LINKS: { href: string; label: string; badge?: number }[] = [ + { href: "/docs", label: "Documentation" }, { href: "/use-cases", label: "Use Cases" }, { href: "/registry", label: "Registry", badge: registry.length }, - { href: "/docs", label: "Docs" }, + { href: "/docs/deployment", label: "Deploy" }, ]; function NavBadge({ count }: { count: number }) { diff --git a/website/src/content/docs/docs/deployment.mdx b/website/src/content/docs/docs/deployment.mdx index 4637217868..b1580c9d23 100644 --- a/website/src/content/docs/docs/deployment.mdx +++ b/website/src/content/docs/docs/deployment.mdx @@ -4,6 +4,8 @@ description: "Choose the right deployment option for agentOS." skill: true --- +import DeployTargets from '../../../components/DeployTargets.astro'; + agentOS is powered by [Rivet](https://rivet.dev), an open-source actor platform, and runs as Rivet Actors. Three ways to run it in production: - **[Rivet Cloud](https://rivet.dev/cloud)**: fully managed (Rivet Compute, or bring your own cloud). Zero-ops. @@ -16,53 +18,7 @@ Pick a deploy target below, or see [Rivet's deployment guides](https://rivet.dev See the [Rivet deploy docs](https://rivet.dev/docs/deploy/) for the full list. Available targets: -
- - -
Rivet Compute
-
Deploy to Rivet's managed compute platform.
- - - -
Vercel
-
Deploy Next.js + RivetKit apps to Vercel's edge network.
- - - -
Railway
-
Deploy containers to Railway's managed infrastructure.
- - - -
Kubernetes
-
Deploy to any Kubernetes cluster with container images.
- - - -
AWS ECS
-
Run containerized workloads on Amazon Elastic Container Service.
- - - -
Google Cloud Run
-
Deploy containers to Google Cloud Run for auto-scaling.
- - - -
Hetzner
-
Deploy to Hetzner's cost-effective cloud infrastructure.
- - - -
VM & Bare Metal
-
Run on virtual machines or bare metal servers with full control.
- - - -
Custom Platform
-
Integrate with any other hosting platform of your choice.
- -
+ ## Enterprise support diff --git a/website/src/content/docs/docs/quickstart.mdx b/website/src/content/docs/docs/quickstart.mdx index c3ec20cab8..20cd7d90e9 100644 --- a/website/src/content/docs/docs/quickstart.mdx +++ b/website/src/content/docs/docs/quickstart.mdx @@ -6,6 +6,7 @@ skill: true import { Aside, Steps } from '@astrojs/starlight/components'; import CodeGroup from '@rivet-dev/docs-theme/components/CodeGroup.astro'; +import DeployTargets from '../../../components/DeployTargets.astro'; import { AGENT_PROMPT } from '../../../components/marketing/agentPrompt';
@@ -177,6 +178,14 @@ import { AGENT_PROMPT } from '../../../components/marketing/agentPrompt'; - **[Permissions & Resource Limits](/docs/permissions)** — Gate what the agent can do and cap its resource usage - **[Bindings](/docs/bindings)** — Expose your JavaScript functions to agents as CLI commands +5. **Deploy** + + By default, agentOS runs locally with `npx rivetkit dev` — no infrastructure needed. To run in production, deploy to any of these targets: + + + + See [Deployment](/docs/deployment) for managed, self-hosted, and agentOS Core options. +