moai-domain-db-docs

To keep database schema documentation in sync with migrations, you can parse migration files to automatically update schema.md, erd.mmd, and migrations.md, reducing manual overhead and preventing documentation drift.

Yes, automated db documentation works with Prisma, Alembic, Rails, and raw SQL migrations. It parses these files to extract table definitions and metadata for updating your documentation artifacts.

You can generate an ERD from database migrations by parsing the migration files to automatically regenerate the erd.mmd file, ensuring your entity relationship diagrams reflect the latest schema changes.

To detect schema drift, you can run a verification workflow that compares your database migration files against existing schema.md and erd.mmd artifacts, reporting inconsistencies and supporting a full refresh.

No, updating schema.md will not overwrite manually edited descriptions. The synchronization process preserves user-edited sections and existing markers while appending new migration data and checksums.

You should trigger a database documentation refresh immediately after applying migrations. This ensures schema.md, erd.mmd, and migrations.md are updated from the new migration content and remain accurately synced.