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

[DOCS]: Add config parameter example for `migrate` function

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

Description

Several docs currently show `migrate(db)` without the required config parameter, which can confuse developers. As of now, the `migrate` function needs a config object, for example:

```ts
await migrate(db, { migrationsFolder: './drizzle' })
```

The option is missing in main docs such as:
- [`src/content/docs/migrations.mdx`](https://github.com/drizzle-team/drizzle-orm-docs/blob/main/src/content/docs/migrations.mdx)

Please update the relevant sections to include the config usage and make it clear this parameter is necessary.

---
*Submitted with the assistance of AI.*

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.