Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mermaid Plugin: Render Inline Mermaid #1243

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

amessbee
Copy link
Contributor

@amessbee amessbee commented Oct 15, 2024

Changes include:

adding mermaid and mermaid vite plugin
update to sequence diagram on orchestration to use inline mermaid

Ref(s):

Copy link

cloudflare-workers-and-pages bot commented Oct 15, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 167f4b8
Status: ✅  Deploy successful!
Preview URL: https://f99cf3e6.documentation-7tp.pages.dev
Branch Preview URL: https://ms-support-inline-mermaid.documentation-7tp.pages.dev

View logs

Copy link

github-actions bot commented Oct 15, 2024

Cloudflare deployment logs are available here

@amessbee amessbee marked this pull request as ready for review October 15, 2024 12:32
@amessbee amessbee self-assigned this Oct 15, 2024
Copy link
Contributor

@toliaqat toliaqat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The deleted image has a reference in other files:

<!-- XXX the diagram below is a useful part of the page but it needs to be updated before it is uncommented. -->
<!-- ## Overview Diagram

Please update the comment or not delete the image if the comment is important and we want to bring the image back in the future. If I were you, I would not add mermaid of the deleted image, and instead undelete the file to merge the original PR as soon as possible.

@amessbee
Copy link
Contributor Author

amessbee commented Oct 17, 2024

The deleted image has a reference in other files:

<!-- XXX the diagram below is a useful part of the page but it needs to be updated before it is uncommented. -->
<!-- ## Overview Diagram

Please update the comment or not delete the image if the comment is important and we want to bring the image back in the future. If I were you, I would not add mermaid of the deleted image, and instead undelete the file to merge the original PR as soon as possible.

Do you think I should undelete other two unused SVG files too? Since, this is not the topic of the current PR, I guess we can keep them and create a separate PR of deleting unused assets?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multiple Files for Sequence Diagrams
2 participants