drizzle-team / drizzle-team/drizzle-orm-docs

Docs: Incorrect component (<Npx>) used for installation step in Studio Quick Start

Open
#576 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
241
Forks
401
Avg merge
5h 44m
Merged PRs (30d)
1

Description

## 🐛 Incorrect Component Used in Drizzle Studio Quick Start Guide

**File:** [src/pages/drizzle-studio/overview.mdx](https://github.com/drizzle-team/drizzle-orm-docs/blob/main/src/pages/drizzle-studio/overview.mdx)
**Location:** [Lines 24–27](https://github.com/drizzle-team/drizzle-orm-docs/blob/main/src/pages/drizzle-studio/overview.mdx?plain=1#L24-L27)

### Problem

The **"Install dependencies"** step in the Quick Start guide incorrectly uses the `` component:

```jsx

drizzle-orm
-D drizzle-kit

```

However, `` is meant for **command execution**, not **dependency installation**. It automatically prepends runners like `npx`, `yarn`, or `pnpm` to the listed lines.

This leads to broken output such as:

```sh
npx drizzle-orm
npx -D drizzle-kit
```

Which is obviously invalid, and will confuse users.

Example output: Image

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.