As it turned out, including the images as base64 encoded string inside the markdown file makes reviews uncomfortable because there is a lot of what seems like text and there are short text elements in between.
Furthermore, the GitHub WebUI diff view when reviewing PRs refuses to display such large text files.
Hence it would be better to allow for import of images and to have them in a consistent manner, we introduce a shortcode to refer to an image.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Type of change
Please delete options that are not relevant.
[X] New feature (non-breaking change which adds functionality)
[X] Design or organisational change
Checklist:
Documentation
[X] I want to update the style, formatting and structure guidelines of this project ( Markdown-Guideline )
[X] I have performed a self-review of my own documentation ( General-Guide )
Technical
[X] I have performed a self-review of my changes
[X] I have made corresponding changes to the documentation
[X] My changes generate no new warnings
[X] New and existing tests pass locally with my changes
As it turned out, including the images as base64 encoded string inside the markdown file makes reviews uncomfortable because there is a lot of what seems like text and there are short text elements in between.
Furthermore, the GitHub WebUI diff view when reviewing PRs refuses to display such large text files.
Hence it would be better to allow for import of images and to have them in a consistent manner, we introduce a shortcode to refer to an image.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Type of change
Please delete options that are not relevant.
Checklist:
Documentation
Technical