Skip to content

fix(docs): remove outdated platform CLI subcommands#7691

Merged
AmanVarshney01 merged 3 commits intomainfrom
dr-7856-update-prisma-cli-docs-for-removed-platform-commands
Mar 23, 2026
Merged

fix(docs): remove outdated platform CLI subcommands#7691
AmanVarshney01 merged 3 commits intomainfrom
dr-7856-update-prisma-cli-docs-for-removed-platform-commands

Conversation

@AmanVarshney01
Copy link
Member

@AmanVarshney01 AmanVarshney01 commented Mar 23, 2026

Summary by CodeRabbit

  • Documentation
    • Removed multiple legacy CLI management pages and "Using the CLI" examples from guides and concepts.
    • Consolidated Platform CLI docs to document a single status command with updated usage and examples.
  • Chores
    • Added permanent redirects from legacy CLI doc URLs to the consolidated console documentation.

The Prisma CLI `prisma platform` command now only supports `status`.
The previously documented subcommands (auth, workspace, project,
environment, apikey) have been removed from the CLI but were still
referenced throughout the docs, causing confusion for users trying
to follow the Console auth and project management workflows.
@vercel
Copy link

vercel bot commented Mar 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment Mar 23, 2026 6:23pm
docs Ready Ready Preview, Comment Mar 23, 2026 6:23pm
eclipse Ready Ready Preview, Comment Mar 23, 2026 6:23pm
site Ready Ready Preview, Comment Mar 23, 2026 6:23pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9e1cf561-04e1-4297-b0f5-3248b7e7215a

📥 Commits

Reviewing files that changed from the base of the PR and between affb7d8 and fe8bbb9.

📒 Files selected for processing (3)
  • apps/docs/content/docs/cli/console/index.mdx
  • apps/docs/content/docs/cli/console/meta.json
  • apps/docs/content/docs/cli/console/status.mdx
✅ Files skipped from review due to trivial changes (1)
  • apps/docs/content/docs/cli/console/status.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • apps/docs/content/docs/cli/console/index.mdx
  • apps/docs/content/docs/cli/console/meta.json

Walkthrough

This PR removes most Prisma Platform CLI subcommand docs and related CLI examples, replaces the main prisma platform CLI page with a focused prisma platform status doc, updates Console navigation metadata, adds a new status page, and adds Vercel redirects from legacy CLI doc routes to the consolidated console CLI page.

Changes

Cohort / File(s) Summary
Removed CLI command pages
apps/docs/content/docs/cli/console/apikey.mdx, apps/docs/content/docs/cli/console/auth.mdx, apps/docs/content/docs/cli/console/environment.mdx, apps/docs/content/docs/cli/console/project.mdx, apps/docs/content/docs/cli/console/workspace.mdx, apps/docs/content/docs/cli/console/platform.mdx
Deleted full MDX pages for individual prisma platform subcommands (frontmatter, usage, actions, options, examples).
CLI index rewrite & metadata
apps/docs/content/docs/cli/console/index.mdx, apps/docs/content/docs/cli/console/meta.json
Rewrote main prisma platform CLI doc to document only prisma platform status (removed other subcommands and --early-access), and updated navigation pages array to ["index","status"] with defaultOpen: true.
Added status command page
apps/docs/content/docs/cli/console/status.mdx
Added new MDX page documenting prisma platform status, including frontmatter, usage, --json option, and examples.
Guides — removed CLI sections
apps/docs/content/docs/console/concepts.mdx, apps/docs/content/docs/console/getting-started.mdx
Removed "Using the CLI" sections and command examples that referenced deleted prisma platform subcommands.
Vercel redirects
apps/docs/vercel.json
Added permanent redirects from legacy CLI doc paths (/docs/cli/console/{auth,workspace,project,environment,apikey,platform}) to /docs/cli/console; minor formatting adjustments.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the primary change: removing outdated Prisma platform CLI subcommand documentation pages while consolidating to a single status command.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@argos-ci
Copy link

argos-ci bot commented Mar 23, 2026

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Mar 23, 2026, 6:28 PM

Redirect old URLs for auth, workspace, project, environment, apikey,
and platform pages to the updated Console CLI reference page.
Match the structure of other CLI command groups (db, migrate, dev)
with an index page for the command group overview and a dedicated
page for each subcommand.
@AmanVarshney01 AmanVarshney01 merged commit ff8d2ec into main Mar 23, 2026
18 of 19 checks passed
@AmanVarshney01 AmanVarshney01 deleted the dr-7856-update-prisma-cli-docs-for-removed-platform-commands branch March 23, 2026 18:24
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