docs(contributing): fix stale DB driver and dev-migration claims#144
Open
rhzs wants to merge 1 commit into
Open
docs(contributing): fix stale DB driver and dev-migration claims#144rhzs wants to merge 1 commit into
rhzs wants to merge 1 commit into
Conversation
Doc Maintainer sweep 2026-07-16 found two materially stale claims in CONTRIBUTING.md, both proven against the implementation: 1. "Drizzle/SQLite" — the server uses Drizzle over Postgres, not SQLite. drizzle.config.ts sets dialect: "postgresql"; db/index.ts tiers between embedded pglite (WASM Postgres, DATABASE_URL unset) and postgres-js over external Postgres. README already says "embedded pglite Postgres". 2. "dev does not auto-migrate" + "db:migrate (apply to the dev DB)" — the default embedded pglite dev tier auto-applies generated migrations in-process at boot (boot.ts ensureServer -> runMigrations; db/index.ts runMigrations migrates the pglite driver). db:migrate (drizzle-kit CLI) targets a real Postgres over the direct :5432 URL only and errors on an empty DATABASE_URL, so it does not apply to the pglite dev tier. Fix: correct the driver to "Drizzle over Postgres"; rewrite the migration note so db:generate authors the SQL and pnpm dev auto-applies it to pglite, with db:migrate scoped to real-Postgres development.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc Maintainer sweep 2026-07-16
First scheduled docs sweep. Reviewed the user-facing documentation at `origin/main` (`752755d`) against the implementation and found two materially stale claims in `CONTRIBUTING.md`. No other user-facing docs (README, daemon README, `docs/`, package scripts, CLI help) drifted.
Finding 1 — wrong database driver: `Drizzle/SQLite`
Claim (CONTRIBUTING.md, Repo layout): `Drizzle/SQLite. Deployed on Fly.`
Evidence it's wrong:
Fix: `Drizzle over Postgres (embedded pglite for local dev, external Postgres in production).`
Finding 2 — wrong dev-migration guidance: "dev does not auto-migrate"
Claim (CONTRIBUTING.md, Run the server locally): `Generate and apply the migration locally — dev does not auto-migrate` with `db:migrate` described as "apply to the dev DB".
Evidence it's wrong:
Fix: `db:generate` authors the SQL (no DB needed); the default embedded pglite dev tier auto-applies it at boot, so restart `pnpm dev`. `db:migrate` is scoped to real-Postgres development (`DATABASE_URL`/`DIRECT_DATABASE_URL`).
Changes
Verification
Follow-up