Mermaid is a tool for generating diagrams for code. It is quickly becoming standard, with GitHub's adoption.
Right now we're defaulting to rendering the Mermaid code on the client side in the configuration, which does not require the CI environment or developer to have Mermaid installed. We may want to change this in the future for performance... potentially by detecting whether Mermaid is installed and opting to pre-render SVG files in the build in that case.
Mermaid doesn't handle deployment infrastructure diagrams. For that, we've documented how to intstall and use diagrams. But since cloud infrastructure may be niche even within Rubin documentation, we won't include that as a default extension and dependency at this time.
Mermaid is a tool for generating diagrams for code. It is quickly becoming standard, with GitHub's adoption.
Right now we're defaulting to rendering the Mermaid code on the client side in the configuration, which does not require the CI environment or developer to have Mermaid installed. We may want to change this in the future for performance... potentially by detecting whether Mermaid is installed and opting to pre-render SVG files in the build in that case.
Mermaid doesn't handle deployment infrastructure diagrams. For that, we've documented how to intstall and use diagrams. But since cloud infrastructure may be niche even within Rubin documentation, we won't include that as a default extension and dependency at this time.