Skip to content

docs(rivet-compute): docs for deploying with github#4460

Merged
NathanFlurry merged 1 commit intomainfrom
03-19-docs_rivet-compute_docs_for_deploying_with_github
Mar 20, 2026
Merged

docs(rivet-compute): docs for deploying with github#4460
NathanFlurry merged 1 commit intomainfrom
03-19-docs_rivet-compute_docs_for_deploying_with_github

Conversation

@abcxff
Copy link
Contributor

@abcxff abcxff commented Mar 20, 2026

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4460 March 20, 2026 01:33 Destroyed
@railway-app
Copy link

railway-app bot commented Mar 20, 2026

🚅 Deployed to the rivet-pr-4460 environment in rivet-frontend

Service Status Web Updated (UTC)
website 😴 Sleeping (View Logs) Web Mar 20, 2026 at 2:15 am
frontend-cloud 😴 Sleeping (View Logs) Web Mar 20, 2026 at 1:44 am
frontend-inspector 😴 Sleeping (View Logs) Web Mar 20, 2026 at 1:41 am
mcp-hub ✅ Success (View Logs) Web Mar 20, 2026 at 1:38 am
ladle ❌ Build Failed (View Logs) Web Mar 20, 2026 at 1:33 am

Copy link
Contributor Author

abcxff commented Mar 20, 2026

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

@abcxff abcxff marked this pull request as ready for review March 20, 2026 01:35
@claude
Copy link

claude bot commented Mar 20, 2026

PR Review: docs(rivet-compute): docs for deploying with GitHub

Overall this is a useful addition to the Connect documentation. The structure is clear and the steps are well-organized. A few concerns worth addressing:

Critical: SKIP_TYPECHECK_CODE_BLOCKS=1 in Dockerfile (website/Dockerfile)

The code in website/src/integrations/typecheck-code-blocks.ts explicitly documents that SKIP_TYPECHECK_CODE_BLOCKS should never be enabled in production. And website/CLAUDE.md confirms this is intentional enforcement. Adding this env var silently disables TypeScript type checking across all documentation code blocks. Please either remove SKIP_TYPECHECK_CODE_BLOCKS=1 and verify the Docker build passes without it, or identify which specific code blocks are failing and fix them properly (applying @nocheck with justification per the docs convention).

Minor: Unnecessary @nocheck on non-TypeScript blocks

The @nocheck flag on dockerfile and yaml code blocks has no effect -- only TypeScript blocks are type-checked. These annotations are harmless but add noise. Only the typescript block warrants @nocheck.

Minor: src/server.js filename should be .ts

The code block opens with a typescript fence labeled src/server.js @nocheck but the content is TypeScript (ES module import syntax). The rest of the RivetKit docs use .ts filenames. This should be src/server.ts.

Nit: Rivet Compute vs Rivet Cloud terminology

The page is titled Deploying to Rivet Compute, the Note at the top says select Rivet Cloud in the dashboard, the token is RIVET_CLOUD_TOKEN, and the step is titled Get Your Cloud Token. A brief sentence clarifying the relationship between Rivet Compute and Rivet Cloud would reduce confusion for first-time readers.

@abcxff abcxff requested a review from NicholasKissel March 20, 2026 01:35
@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 20, 2026

More templates

@rivetkit/cloudflare-workers

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

@rivetkit/framework-base

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

@rivetkit/next-js

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

@rivetkit/react

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

rivetkit

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

@rivetkit/sql-loader

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

@rivetkit/sqlite-vfs

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/sqlite-vfs@4460

@rivetkit/traces

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

@rivetkit/workflow-engine

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/workflow-engine@4460

@rivetkit/virtual-websocket

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/virtual-websocket@4460

@rivetkit/engine-runner

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

@rivetkit/engine-runner-protocol

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

commit: cf492b8

@abcxff abcxff force-pushed the 03-19-docs_rivet-compute_docs_for_deploying_with_github branch from aab5b21 to c31fdaa Compare March 20, 2026 01:37
@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4460 March 20, 2026 01:37 Destroyed
@abcxff abcxff force-pushed the 03-19-docs_rivet-compute_docs_for_deploying_with_github branch from c31fdaa to cf492b8 Compare March 20, 2026 02:04
@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4460 March 20, 2026 02:04 Destroyed
@NathanFlurry NathanFlurry merged commit 74dda9a into main Mar 20, 2026
15 of 19 checks passed
@NathanFlurry NathanFlurry deleted the 03-19-docs_rivet-compute_docs_for_deploying_with_github branch March 20, 2026 20:25
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.

2 participants