WIP docs(compute): base Compute docs (internal)#7800
Open
ArthurGamby wants to merge 16 commits intomainfrom
Open
WIP docs(compute): base Compute docs (internal)#7800ArthurGamby wants to merge 16 commits intomainfrom
ArthurGamby wants to merge 16 commits intomainfrom
Conversation
Adds a new top-level Compute section under apps/docs covering the EA release: overview, Next.js and Bun quickstarts, dual-CLI reference for @looma/prisma-cli and @prisma/compute-cli (incl. env var management), log streaming with the 10-min / single-stream EA limits, and a consolidated limitations page. Also wires the Compute tab into the v7 top navbar. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
🍈 Lychee Link Check Report82 links: ✅ All links are working!Full Statistics Table
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
Contributor
WalkthroughAdded new documentation section for Prisma Compute with a comprehensive reference guide covering deployment workflows for Next.js and Bun applications. Includes quickstart instructions, CLI command documentation, environment variable management, and logging features, alongside supporting navigation and configuration updates. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/docs/content/docs/compute/cli.mdx`:
- Around line 111-127: The examples use a unicode ellipsis placeholder
("sk_live_…") which can be miscopied into shells; update the command examples
shown for npx `@looma/prisma-cli` app update-env and bunx `@prisma/compute-cli` env
update to use explicit, safe placeholders like <your-stripe-key> or
YOUR_STRIPE_KEY (and similarly explicit placeholders for DATABASE_URL) so
readers copy a clear token instead of an ellipsis.
- Around line 7-24: The spellcheck CI is failing on the token "looma" in this
MDX doc; either add a local cspell ignore directive for looma at the top of this
MDX file (e.g., a cspell:ignore declaration) or add "looma" to the project's
cspell dictionary (cspell.json -> words array) so that occurrences like the
package name and table entries are accepted; update the doc and commit the
change so CI picks up the new ignore.
In `@apps/docs/content/docs/compute/limitations.mdx`:
- Line 19: Spellcheck is failing because the package scope `looma` (seen in the
token `@looma/prisma-cli`) is not in the cspell dictionary; fix by either adding
"looma" to the shared cspell dictionary (e.g., add "looma" into the project's
cspell word list) or add a page-local directive at the top of the MDX file using
a cspell:words comment (e.g., `<!-- cspell:words looma -->`) to whitelist
`looma` for this and sibling pages; update the shared cspell word list if you
want a global fix, otherwise add the `cspell:words` directive inside the Compute
docs MDX files that reference `@looma/prisma-cli`.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 459f48b3-84e8-4432-a72a-693775e64c79
📒 Files selected for processing (9)
apps/docs/content/docs/compute/cli.mdxapps/docs/content/docs/compute/index.mdxapps/docs/content/docs/compute/limitations.mdxapps/docs/content/docs/compute/logs.mdxapps/docs/content/docs/compute/meta.jsonapps/docs/content/docs/compute/quickstart-bun.mdxapps/docs/content/docs/compute/quickstart-nextjs.mdxapps/docs/content/docs/meta.jsonapps/docs/src/lib/layout.shared.tsx
Comment on lines
+7
to
+24
| metaDescription: Reference for the Prisma Compute CLIs. Authentication, deploy, and environment variable commands for @looma/prisma-cli and @prisma/compute-cli. | ||
| --- | ||
|
|
||
| Two CLIs currently target Prisma Compute during Early Access. This page documents the commands needed day-to-day: install, authenticate, deploy, and manage environment variables. | ||
|
|
||
| | Package | Binary | Typical invocation | | ||
| |---|---|---| | ||
| | [`@looma/prisma-cli`](https://www.npmjs.com/package/@looma/prisma-cli) | `prisma` | `npx @looma/prisma-cli …` | | ||
| | [`@prisma/compute-cli`](https://www.npmjs.com/package/@prisma/compute-cli) | `compute` | `bunx @prisma/compute-cli …` | | ||
|
|
||
| ## Authentication | ||
|
|
||
| Run an interactive browser flow once per machine. Credentials are stored locally. | ||
|
|
||
| ### Using `@looma/prisma-cli` | ||
|
|
||
| ```bash | ||
| npx @looma/prisma-cli auth login |
Contributor
There was a problem hiding this comment.
Fix CI blocker: cspell rejects looma in multiple spots
Lines 7, 14, 21, and 24 currently fail spellcheck. Please add a local cspell ignore (or project dictionary entry) so docs CI can pass.
Proposed fix (local to this doc)
---
title: CLI reference
description: Authenticate, deploy, and manage environment variables for Prisma Compute from the CLI.
badge: early-access
url: /compute/cli
metaTitle: CLI reference | Prisma Compute
metaDescription: Reference for the Prisma Compute CLIs. Authentication, deploy, and environment variable commands for `@looma/prisma-cli` and `@prisma/compute-cli`.
---
+<!-- cspell:ignore looma -->
+
Two CLIs currently target Prisma Compute during Early Access. This page documents the commands needed day-to-day: install, authenticate, deploy, and manage environment variables.🧰 Tools
🪛 GitHub Actions: Spellcheck
[error] 7-7: cspell reported unknown word "looma" at line 7 (e.g., "-- variable commands for @looma/prisma-cli and @prisma").
[error] 14-14: cspell reported unknown word "looma" in a markdown table/link at line 14.
[error] 14-14: cspell reported unknown word "looma" in inline code at line 14.
[error] 21-21: cspell reported unknown word "looma" at line 21 (heading: "### Using @looma/prisma-cli").
[error] 24-24: cspell reported unknown word "looma" at line 24 (command: "npx @looma/prisma-cli auth login").
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@apps/docs/content/docs/compute/cli.mdx` around lines 7 - 24, The spellcheck
CI is failing on the token "looma" in this MDX doc; either add a local cspell
ignore directive for looma at the top of this MDX file (e.g., a cspell:ignore
declaration) or add "looma" to the project's cspell dictionary (cspell.json ->
words array) so that occurrences like the package name and table entries are
accepted; update the doc and commit the change so CI picks up the new ignore.
Comment on lines
+111
to
+127
| npx @looma/prisma-cli app update-env --app my-app --env STRIPE_KEY=sk_live_… | ||
| ``` | ||
|
|
||
| List the current values: | ||
|
|
||
| ```bash | ||
| npx @looma/prisma-cli app list-env | ||
| npx @looma/prisma-cli app list-env --app my-app | ||
| ``` | ||
|
|
||
| #### Using `@prisma/compute-cli` | ||
|
|
||
| ```bash | ||
| bunx @prisma/compute-cli env update --env DATABASE_URL=postgresql://example | ||
| bunx @prisma/compute-cli env update \ | ||
| --env STRIPE_KEY=sk_live_… \ | ||
| --env NODE_ENV=production |
Contributor
There was a problem hiding this comment.
Use explicit placeholders instead of … in secret examples
On Line 111 and Line 126, sk_live_… is easy to miscopy and the unicode ellipsis can be pasted literally in shells. Prefer clear placeholders like <your-stripe-key>.
Suggested doc tweak
-npx `@looma/prisma-cli` app update-env --app my-app --env STRIPE_KEY=sk_live_…
+npx `@looma/prisma-cli` app update-env --app my-app --env STRIPE_KEY=<your-stripe-key>
...
- --env STRIPE_KEY=sk_live_… \
+ --env STRIPE_KEY=<your-stripe-key> \📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| npx @looma/prisma-cli app update-env --app my-app --env STRIPE_KEY=sk_live_… | |
| ``` | |
| List the current values: | |
| ```bash | |
| npx @looma/prisma-cli app list-env | |
| npx @looma/prisma-cli app list-env --app my-app | |
| ``` | |
| #### Using `@prisma/compute-cli` | |
| ```bash | |
| bunx @prisma/compute-cli env update --env DATABASE_URL=postgresql://example | |
| bunx @prisma/compute-cli env update \ | |
| --env STRIPE_KEY=sk_live_… \ | |
| --env NODE_ENV=production | |
| npx `@looma/prisma-cli` app update-env --app my-app --env STRIPE_KEY=<your-stripe-key> |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@apps/docs/content/docs/compute/cli.mdx` around lines 111 - 127, The examples
use a unicode ellipsis placeholder ("sk_live_…") which can be miscopied into
shells; update the command examples shown for npx `@looma/prisma-cli` app
update-env and bunx `@prisma/compute-cli` env update to use explicit, safe
placeholders like <your-stripe-key> or YOUR_STRIPE_KEY (and similarly explicit
placeholders for DATABASE_URL) so readers copy a clear token instead of an
ellipsis.
|
|
||
| ## CLI | ||
|
|
||
| - **Two CLIs coexist.** `@looma/prisma-cli` (unified `prisma app …`) is the direction of travel; `@prisma/compute-cli` (original `compute …`) is the fallback for features or fixes that haven't reached the new CLI yet. |
Contributor
There was a problem hiding this comment.
CI blocker: cspell rejects looma across Compute docs.
Spellcheck is failing on a legitimate package scope. Add looma to the shared cspell dictionary (preferred), or annotate with a local cspell:words directive to unblock this page and sibling pages.
Suggested minimal page-local fix (if global dictionary update is deferred)
---
title: Known limitations
description: What is and isn't supported in Prisma Compute during Early Access.
badge: early-access
url: /compute/limitations
metaTitle: Known limitations | Prisma Compute
metaDescription: A running list of known limitations in Prisma Compute during the Early Access window.
---
+<!-- cspell:words looma -->🧰 Tools
🪛 GitHub Actions: Spellcheck
[error] 19-19: cspell reported unknown word "looma" at line 19.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@apps/docs/content/docs/compute/limitations.mdx` at line 19, Spellcheck is
failing because the package scope `looma` (seen in the token
`@looma/prisma-cli`) is not in the cspell dictionary; fix by either adding
"looma" to the shared cspell dictionary (e.g., add "looma" into the project's
cspell word list) or add a page-local directive at the top of the MDX file using
a cspell:words comment (e.g., `<!-- cspell:words looma -->`) to whitelist
`looma` for this and sibling pages; update the shared cspell word list if you
want a global fix, otherwise add the `cspell:words` directive inside the Compute
docs MDX files that reference `@looma/prisma-cli`.
Merges the six sub-pages (quickstarts, CLI, logs, limitations) into one page at /docs/v7/compute, using Tabs for the Next.js|Bun choice and CodeBlockTabs for the @looma|@prisma/compute-cli choice — same ergonomic as npm|pnpm|yarn|bun code switching. Simpler for internal EA users who want everything in one place. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
ArthurGamby
changed the title
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
ArthurGamby
changed the title
ArthurGamby
changed the title
Reflect the new SDK build strategies (prisma/project-compute#67) in the internal Compute docs. Adds framework-specific scaffolding tabs and updates the limitations list to replace "Next.js and Bun/Hono only". Deploys stay zero-flag; the SDK auto-detects the framework. Refs: PTL-1391
…team) Separate the Compute docs into two surfaces so Mike's incoming launch-docs pass has a clean target while preserving the team's experimentation notes. Rationale: from #project-compute on 2026-04-23, Shane confirmed that user-facing docs should promote `prisma-cli` (the future unified CLI) and that `@looma/prisma-cli` / `@prisma/compute-cli` are temporary internal tools, not for users. Prisma Compute public beta launches 2026-05-13; keeping the /compute URL stable now avoids a rename flip on launch day. /compute (new, Official): - Landing page, 5 framework quickstarts, env vars, logs, limitations. - Every command uses `prisma` directly (no looma/compute-cli). - No "EA" language, no badges, no #product-compute references. - Structure/content are a skeleton Mike can refine; examples work today via `alias prisma=prisma-cli` per Shane's workaround. /compute-internal (moved from the previous /compute tree): - All current content preserved verbatim: both CLIs, PR #68 env detail, team channel references, full quickstart flows. - Each page carries a warning Alert linking back to /compute so the scope is always visible. - meta.json title reads "Compute (Internal)". - URLs rewritten from /compute/* to /compute-internal/*. Refs: PTL-1391
Wire /compute-internal into the v7 top navbar as a sibling of Compute. Extend the warning Alert on every internal page to state the section will be removed after the public beta launch on 2026-05-13. This branch is intentionally not merged to main; the nav entry exists so the team can access the internal reference on preview deploys during the run-up to launch.
<Alert> is not registered as a bare MDX component in mdx-components.tsx (only the ::: directive path maps to it via CalloutContainer), so direct JSX usage threw a missing-reference runtime error.
Uses existing SVGs in /public/img/technologies/ for Next.js, Astro (dark variant), Nuxt, and TanStack. Adds a placeholder bun.svg (simple bun glyph) since no Bun logo existed in the repo. Both /compute and /compute-internal index pages get the same icon treatment. Next.js logo is black-on-transparent, so it carries `dark:invert` to render correctly on the dark docs theme.
The MDX `img` tag is overridden to a Next.js Image wrapper in mdx-components.tsx, which requires explicit width and height props. Without them the page 500s during render.
Moves the img into the `title` prop (wrapped in a flex span) instead of passing it via the separate `icon` prop, so the logo sits on the same line as the framework name rather than above it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
apps/docs/content/docs/compute/: overview, Next.js and Bun quickstarts, dual-CLI reference (@looma/prisma-cli+@prisma/compute-cli) including env-var management, log streaming with the 10-min / single-stream EA limits, and a consolidated limitations page.src/lib/layout.shared.tsx) between Postgres and CLI. v6 nav is untouched.content/docs.v6/.Source material: How the hell do I compute? + CLI
--helpoutput for both@looma/prisma-cliand@prisma/compute-cli(so command flags are accurate, not guessed). Linear project: Compute until Offsite.Intended audience: internal hackathon / EA users.
Test plan
pnpm --filter docs devand openhttp://localhost:3001/docs/v7/compute— confirm the Compute tab appears in the navbar between Postgres and CLI, with theCpuicon and the Introduction / Quickstart / CLI / More sidebar sections.index,quickstart-nextjs,quickstart-bun,cli,logs,limitations) and verify it renders with theearly-accessbadge and no MDX compile errors.http://localhost:3001/docs/v6/…— confirm Compute does not appear in the v6 navbar or sidebar.output: "standalone"gotcha).🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes