Skip to content

docs: move public docs into a docs/ bundle for rivet.dev - #5559

Merged
NathanFlurry merged 2 commits into
mainfrom
docs/website-split
Aug 11, 2026
Merged

docs: move public docs into a docs/ bundle for rivet.dev#5559
NathanFlurry merged 2 commits into
mainfrom
docs/website-split

Conversation

@NathanFlurry

Copy link
Copy Markdown
Member
  • Move the public docs out of website/ into a docs/ bundle (docs/sidebar.json + docs/content/**), which rivet.dev links in directly
  • Delete website/, now served from the website repo
  • Move the Workflows docs out to the Workflows product
  • Move the container runner under Actors documentation, and surface the regions page under Concepts
  • Drop the TypeDoc links, whose generated output was retired
  • Move the skills publishing workflow to the website repo, and add a docs sync workflow
  • Add a docs CLAUDE.md describing the bundle contract

@railway-app

railway-app Bot commented Aug 11, 2026

Copy link
Copy Markdown

🚅 Deployed to the actors-pr-5559 environment in rivet-frontend

Service Status Web Updated (UTC)
website 🕒 Building (View Logs) Web Aug 11, 2026 at 1:43 pm
frontend-cloud 🕒 Building (View Logs) Web Aug 11, 2026 at 1:43 pm
frontend-inspector 🕒 Building (View Logs) Web Aug 11, 2026 at 1:43 pm
mcp-hub 🕒 Building (View Logs) Web Aug 11, 2026 at 1:43 pm
kitchen-sink 🕒 Building (View Logs) Web Aug 11, 2026 at 1:43 pm
ladle ❌ Build Failed (View Logs) Web Aug 11, 2026 at 7:38 am

@railway-app
railway-app Bot temporarily deployed to rivet-frontend / actors-pr-5559 August 11, 2026 07:38 Destroyed
@railway-app
railway-app Bot temporarily deployed to rivet-frontend / actors-pr-5559 August 11, 2026 10:03 Destroyed
@railway-app
railway-app Bot temporarily deployed to rivet-frontend / actors-pr-5559 August 11, 2026 10:04 Destroyed
@railway-app
railway-app Bot temporarily deployed to rivet-frontend / actors-pr-5559 August 11, 2026 13:43 Destroyed
@NathanFlurry
NathanFlurry merged commit 93a168f into main Aug 11, 2026
4 of 14 checks passed
@NathanFlurry
NathanFlurry deleted the docs/website-split branch August 11, 2026 13:43
@claude

claude Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Review

This is largely a mechanical docs move (website/docs/ bundle), and the bulk of the renamed .mdx files look fine on spot-check (no leftover /docs/deploy/* or rivet.gg links). A few real issues turned up in the non-doc changes bundled into this PR, plus some doc-content nits.

Bugs

1. frontend/packages/shared-data/src/deploy.ts refactor breaks its consumers (high confidence)

This PR removes href from DeployOption (replaced by slug) and drops "rivet" from the Provider union entirely, but several frontend files that weren't touched by this PR still reference the old shape:

  • frontend/src/app/dialogs/connect-manual-serverless-frame.tsx:236providerOptions?.href
  • frontend/src/app/dialogs/connect-manual-serverful-frame.tsx:241providerOptions?.href
  • frontend/src/app/compute-deploy.tsx:54-55providerDetails?.href, and :61, :77, :85 compare provider === "rivet" / pass provider: "rivet"
  • frontend/src/app/getting-started.tsx:221,447provider !== "rivet", deployOptions.find((o) => o.name !== "rivet")

Since href no longer exists on DeployOption and "rivet" no longer exists in Provider, these should fail tsc/pnpm check-types. Even setting the type error aside, at runtime providerOptions?.href is now always undefined, so every "follow the integration guide" link falls back to the hardcoded /docs/getting-started placeholder instead of the real per-provider guide, and the provider === "rivet" branches that drive the "Rivet Compute" cloud deploy flow can never match anymore since no deployOptions entry has name: "rivet". I wasn't able to run tsc in this environment (no node_modules), but this is a straightforward grep-confirmed mismatch — worth running pnpm check-types in frontend/ before merge and updating these four files (or keeping a "rivet"/href-compatible shim) to match the new slug/support shape.

2. New self-host/control-plane/docker-compose/docker-compose.yml references a Dockerfile that doesn't exist

The runner service:

runner:
  build:
    context: ../..
    dockerfile: docker/runner/Dockerfile

resolves dockerfile: relative to context: (self-host/), i.e. self-host/docker/runner/Dockerfile. That path doesn't exist, and there's no docker/runner/Dockerfile anywhere else in the repo either (only docker/engine/Dockerfile and docker/compute-hello-world/Dockerfile). docker-compose up for this new self-host guide will fail on the runner service. Compare with self-host/workers/docker-compose/, which ships its own local Dockerfile next to compose.yaml with build: . — that looks like the intended pattern here too.

Nits

  • self-host/control-plane/docker-compose/README.md reads as unedited boilerplate from the (unrelated) self-host/compose/template generator — it documents ClickHouse, NATS, PostgreSQL, Vector Server, OTel Collector, and a "Rivet Shell" service, none of which exist in the actual 2-service docker-compose.yml added here. Likely to confuse anyone following the new guide.
  • self-host/control-plane/custom/README.md and self-host/control-plane/vm/README.md both list commands-2.sh under "Files," but only commands.sh exists in either directory.

Things that look good

  • docs/CLAUDE.md is clear and includes the required AGENTS.md symlink.
  • .github/workflows/docs-sync.yml's extra-paths all resolve to real paths in this repo, and the frontend.yml/skills.yml/pnpm-workspace.yaml cleanup for the deleted website/ package is consistent.
  • scripts/run/k8s/engine.sh's path update (self-host/k8s/engineself-host/control-plane/kubernetes) matches the renamed directory.

Test coverage

Docs-only moves don't need new tests, but given this PR also ships real logic changes (deploy.ts shape, new docker-compose bundle), it'd be good to confirm pnpm check-types passes in frontend/ and to smoke-test docker-compose up (or at least docker-compose config) against the new self-host/control-plane/docker-compose/ bundle before merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant