And with diagrams as text close to the code chances are they will be kept to up to date (and created to begin with…).

It is handy to manually generate the diagram from times to times using the previously created command: npm run db:diagram:generate. Though, getting the diagram to update itself on its own automatically without a developer interaction would ensure that it the diagram is never obsolete. There are several ways of doing this.You could use a pre-commit git hook or even better simply configure your CI/CD pipeline(s) to run the npm script whenever something gets merged into the main branch 🙂

When it comes to showing up somewhere in your documentation a diagram describing your SQL database, you often end up with a recurring problem : after a few days / weeks / months, the diagram you made became obsolete.

Do you really need those lines? Isn’t it clear enough? Well, I still find comments like this in a lot of cases and it gets funnier when the comment is obsolete and the code is doing other things. Following the example, let’s imagine that another developer adds support for PUT method. I think that this is what would happen.

Sprockets 4: The effect of config.assets.debug does not match the rails documentation.

This appears to be an undocumented breaking change. For example, the word "debug" does not appear in the sprockets 4 changelog.

The docs say: "When using Rails and Sprockets in development mode, no assets are concatenated."