We are currently using Mermaid to generate the Database schema images for docs.
It's a bit overkill for 2 PNGs, and it includes some heavy dependencies (puppeteer).
We could either use npx (or in the future pnpm dlx) to use Mermaid.
Or just use Github Markdown syntax to include Mermaid diagrams directly.
The 2nd option seems the best, ideally we could still have a separate .mmd file and just import it in the docs (to be checked).
Otherwise just move the whole mermaid content to the docs/database.md
ACs
Remove mermaid and its dependencies (including npm script, shell file, etc)
Embed the mermaid graph directly into the markdown file docs/
Description
We are currently using Mermaid to generate the Database schema images for docs. It's a bit overkill for 2 PNGs, and it includes some heavy dependencies (
puppeteer).We could either use
npx(or in the futurepnpm dlx) to use Mermaid. Or just use Github Markdown syntax to include Mermaid diagrams directly.The 2nd option seems the best, ideally we could still have a separate
.mmdfile and just import it in the docs (to be checked). Otherwise just move the whole mermaid content to thedocs/database.mdACs
docs/