Skip to content

docs: Fix incorrect directory in "Connect Drizzle ORM to the Database" sections #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

harryplusplus
Copy link

Summary

This PR fixes a small documentation inconsistency found in several "Getting Started" pages:

Create a index.ts file in the src/db directory and initialize the connection

The code examples and file structure suggest that the correct path should be:

Create a index.ts file in the src directory

Affected docs

  • Neon
  • Nile
  • pgLite
  • PostgreSQL
  • Supabase
  • Vercel
  • Xata

Motivation

This change improves clarity and helps prevent confusion for new users setting up Drizzle ORM.

Related Issue

Closes #524


Let me know if anything needs to be updated or if you'd like me to split this into smaller PRs!

Several guides said to create index.ts in src/db,
but examples actually expect src/index.ts.
This fixes the doc for consistency and clarity.
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.

Incorrect directory mentioned in "Connect Drizzle ORM to the database" steps
1 participant