Skip to content

Getting Started guide improvements (all guides) #2747

@keerlu

Description

@keerlu

These changes apply to all the Getting Started guides. Originally documented as part of the Notion section here.

Related issue: #2820 for the PlanetScale guide. Many of the points there may apply to all other guides.

In all guides, the following sections need updating:

Add to existing databases > Querying the database

These need to be updated to match the explanations in 'Start from scratch > Querying the database'. In particular, need to explain that the first time you run npx ts-node index.ts it will return an empty array.

Add to existing databases > Introspection

  • The section starting with “Sometimes though, you may want to make additional changes to the names of the columns...” is kind of out of place for a getting started tutorial. Would be better somewhere else
    • Suggestion: All this could go into a collapsible "Learn how to fix this, if that is not the case" to make the page much shorter.
  • PostgreSQL: should now have referential actions in introspected SQL. This probably applies to other DBs too - need to rerun the commands and see. See Update Prisma schemas created via Introspection from provided SQL #2752

Add to existing databases > Connect your database and Start from scratch > Connect your database

  • In the 'Connect your database' section starting from: ‘The url is set from an environment variable’: Before this sentence would be a good place to add a structuring headline that lets the user know that everything that follows is now about the connection string or URL. (vs. choosing the connector in the first half of the document)

Metadata

Metadata

Assignees

Labels

type/docsDocumentation creation, updates or corrections

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions