Skip to content

docs: fix preview errors in the flowchart documentation #6600

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 28, 2025
Merged

docs: fix preview errors in the flowchart documentation #6600

merged 2 commits into from
May 28, 2025

Conversation

kimulaco
Copy link
Contributor

📑 Summary

I fixed the following example preview errors in the Flowchart documentation.

  • The "Image Shape" example code fails to render because the sample image URL (https://example.com/image.png) is not accessible
  • The "Markdown Strings" example has a syntax error

Resolves #6599

📏 Design Decisions

There is no change in syntax.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented May 18, 2025

⚠️ No Changeset found

Latest commit: e6be1e9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify Netlify
Copy link

netlify bot commented May 18, 2025 •
edited
Loading

✅ Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit e6be1e9
🔍 Latest deploy log https://app.netlify.com/projects/mermaid-js/deploys/6829fc3655a5200008729793
😎 Deploy Preview https://deploy-preview-6600--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented May 18, 2025

Open in StackBlitz

mermaid

npm i https://pkg.pr.new/mermaid-js/mermaid@6600

@mermaid-js/mermaid-zenuml

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6600

@mermaid-js/layout-elk

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6600

@mermaid-js/parser

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6600

@mermaid-js/tiny

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/tiny@6600

commit: e6be1e9

@codecov Codecov
Copy link

codecov bot commented May 18, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 3.87%. Comparing base (015afc5) to head (e6be1e9).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6600   +/-   ##
=======================================
  Coverage     3.87%   3.87%           
=======================================
  Files          414     414           
  Lines        43291   43291           
  Branches       666     666           
=======================================
  Hits          1679    1679           
  Misses       41612   41612
Flag Coverage Δ
unit 3.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@argos-ci Argos CI
Copy link

argos-ci bot commented May 18, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - May 18, 2025, 3:36 PM

@sidharthv96 sidharthv96 added this pull request to the merge queue May 22, 2025
@sidharthv96 sidharthv96 self-assigned this May 22, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 22, 2025
@sidharthv96 sidharthv96 merged commit 8a703bd into mermaid-js:develop May 28, 2025
22 checks passed
@mermaid-bot mermaid-bot
Copy link

mermaid-bot bot commented May 28, 2025

@kimulaco, Thank you for the contribution!
You are now eligible for a year of Premium account on MermaidChart.
Sign up with your GitHub account to activate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@sidharthv96 sidharthv96

Labels
Area: Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation preview errors in Flowchart syntax
2 participants
@kimulaco @sidharthv96