docs(rivet-compute): docs for deploying with github#4460
Conversation
|
🚅 Deployed to the rivet-pr-4460 environment in rivet-frontend
|
PR Review: docs(rivet-compute): docs for deploying with GitHubOverall 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. |
aab5b21 to
c31fdaa
Compare
c31fdaa to
cf492b8
Compare

Description
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Checklist: