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

Open Beginner friendly
#652 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Open src/content/docs/migrations.mdx and find the sections that show migrate(db). Update the examples to include a config object such as { migrationsFolder: './drizzle' }, and state that the parameter is required. Done means the relevant migration examples consistently show the required config usage.

Written by the indexing model from the issue text.

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:

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

The option is missing in main docs such as:

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

Submitted with the assistance of AI.

Dominant language
MDX
Stars
241
Forks
402
Avg merge
4d 6h
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from drizzle-team/drizzle-orm-docs

All issues in drizzle-team/drizzle-orm-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.