intershop-pwa icon indicating copy to clipboard operation
intershop-pwa copied to clipboard

docs: Introduce Mermaid Diagrams - WiP

Open marschmidt89 opened this issue 1 year ago • 0 comments

This pull request introduces Mermaid diagrams and replaces some existing .png format diagrams.

Mermaid lets you create diagrams and visualizations using text and code. It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.

Note, however, that this only applies to diagrams of any kind, and cannot replace screenshots, photos, or illustrations.

This approach brings several advantages:

  • Changes in images can be tracked via Git
  • No more image sources stored in other systems
  • Easy to translate if required
  • Consistent style

Links:

To Do

With this pull request, three original diagrams were replaced. However, especially the two deployment-related diagrams lack descriptions which should be added. The original graphics are still included for reference and should be removed once the Mermaid versions are ready.

PR Type

[ ] Bugfix [X] Feature [ ] Code style update (formatting, local variables) [ ] Refactoring (no functional changes, no API changes) [ ] Build-related changes [ ] CI-related changes [ ] Documentation content changes [ ] Application / infrastructure changes [ ] Other:

Does this PR Introduce a Breaking Change?

[ ] Yes [X] No

Other Information

Since it affects visualizations, please clarify if VD/UX should be involved as well.

AB#87890

marschmidt89 avatar Jul 18 '23 11:07 marschmidt89