Documentation for #2509

[jason-curtis]

📑 Summary

Since #2509 is unlikely to be solved soon I'm adding some documentation. This should at least make the behavior less surprising.

I don't think it actually resolves #2509 but since this is expected behavior per @knsv (here) maybe #2509 can be recategorized as a feature request.

📏 Design Decisions

Nothing surprising here. I included an illustrative example.

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added necessary unit/e2e tests.
  • (N/A - documentation only)
• 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
• 🔖 targeted develop branch

[codecov]

Codecov Report

Merging #4740 (edb6cea) into develop (99978da) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4740   +/-   ##
========================================
  Coverage    77.18%   77.18%           
========================================
  Files          145      145           
  Lines        14659    14659           
  Branches       586      586           
========================================
  Hits         11315    11315           
  Misses        3233     3233           
  Partials       111      111           

Flag	Coverage Δ
e2e	83.90% <ø> (ø)
unit	46.10% <ø> (ø)

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

[sidharthv96]

@jason-curtis can you run prettier to fix the formatting issues?

https://mermaid.js.org/community/development.html#contributing-documentation

[jason-curtis]

@sidharthv96 It's hard to see how these lint errors could be from my change. I don't see any mention of prettier in the documentation you sent, so maybe something is missing?

I'll try running prettier and see what happens.

[sidharthv96]

Prettier is run automatically when you commit locally, once you have run pnpm install.
Committing locally would also build the docs and inject that into the PR.

[jason-curtis]

ah I see the prettier issue now. I didn't see the [warn] packages/mermaid/src/docs/syntax/flowchart.md amidst all of the yellow eslint warnings!

I've been trying to get everything to install and build cleanly on a fresh GH codespace, no luck so far.

curl https://get.volta.sh | bash
# (restart terminal here)
volta install node
npx pnpm install # and then you have to tell it yes, install pnpm
# ^ this command fails.

Here's a full gist of the 2nd terminal session: https://gist.github.com/jason-curtis/746affa2385639c8fd2ea3c0332c70e3
It looks like the error is:

packages/mermaid/src/setupGraphViewbox.js (2:9) "SVG" is not exported by "packages/mermaid/src/diagram-api/types.ts", imported by "packages/mermaid/src/setupGraphViewbox.js".

At this point the package is at least partially installed, so I may be able to bash through by manually running prettier (already did this in #ef8b75a ) and the docs build (I'll try this next).

[jason-curtis]

OK, I was able to manually run npx pnpm --filter mermaid run docs:build as suggested in the latest failed job so hopefully that'll cover it.

It looks like things are pretty OK in my latest codespace despite the error when running npx pnpm install - I guess it came close enough to completing the install properly.

Thanks for your guidance.

[sidharthv96]

@jason-curtis thank you! I'll fix the SVG error.

[sidharthv96]

Yeah, the final step of install is the build, which failed due to the SVG bug.
But prettier and docs don't really need that.

[mermaid-bot]

@jason-curtis, 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.