Skip to content

feat: add Drizzle ORM documentation - #2750

Open
TiberiusNemesis wants to merge 3 commits into
freeCodeCamp:mainfrom
TiberiusNemesis:fm/drizzle-orm-docs
Open

TiberiusNemesis wants to merge 3 commits into
freeCodeCamp:mainfrom
TiberiusNemesis:fm/drizzle-orm-docs

Conversation

@TiberiusNemesis

@TiberiusNemesis TiberiusNemesis commented Oct 7, 2026 •

Copy link
Copy Markdown

Adds Drizzle ORM (1.0.0-rc.4) with one version per SQL dialect: PostgreSQL, MySQL, SQLite, SingleStore, MSSQL and CockroachDB. The site keeps a separate copy of the docs for each dialect, with different pages and examples, so each one is its own version.

  • Skips the get-started tutorials, guides, sponsors page and changelog.
  • Entries come from the sidebar. Data types, filter operators and seed generators are indexed as standalone entries.
  • Code tabs become consecutive code blocks titled after their tab.
  • get_latest_version takes the newer of npm's latest and rc tags, since the site documents the 1.0 RCs while latest is still 0.x.

Generated all six locally (327 to 405 entries each) and checked them in the app.

https://orm.drizzle.team/docs/overview

The website keeps one copy of the documentation per SQL dialect, picked
with its dialect switcher: PostgreSQL's at /docs/, the others under
/docs/mysql/, /docs/sqlite/, /docs/singlestore/, /docs/mssql/ and
/docs/cockroach/. Their pages, sidebars and code examples differ (e.g.
sequences and row-level security are PostgreSQL-only, every dialect has
its own data types and drivers), so each dialect is scraped as a version
of the documentation, the way the RethinkDB languages and the Haxe
targets are: drizzle~postgresql, drizzle~mysql, drizzle~sqlite,
drizzle~singlestore, drizzle~mssql and drizzle~cockroachdb.

The website documents the 1.0 release candidates (drizzle-orm@rc), hence
the 1.0.0-rc.4 release; get_latest_version reports the newest of npm's
latest and rc tags.

Left out: the "Get started" tutorials, which the drivers' pages cover,
the sponsors and changelog pages, and the guides and tutorials, articles
which every dialect lists whichever dialect they are about.

The documentation's repository (drizzle-team/drizzle-orm-docs) has no
license file of its own; the attribution uses Drizzle ORM's Apache 2.0
license.

The icon is the website's favicon, downscaled for the 16x16 version.
@TiberiusNemesis
TiberiusNemesis requested a review from a team as a code owner October 7, 2026 03:46
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.

1 participant