mermaid-js / mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
https://mermaid.js.org
MIT License
68.69k stars 6.07k forks source link

Tiny improvements to Diagram Syntax sidebar #5532

Closed TWiStErRob closed 1 month ago

TWiStErRob commented 1 month ago

:bookmark_tabs: Summary

Improving this:

image

:straight_ruler: Design Decisions

The titles of the sections on the website should be human friendly. "Zenuml" is not, as it looks like a word, so capitalized UML to call out what it's meant to say. "XYChart" is a class name, the opened page shows "XY Chart" to match all the other sections which have names closer to the actual page contents.

:clipboard: Tasks

Make sure you

netlify[bot] commented 1 month ago

Deploy Preview for mermaid-js ready!

Name Link
Latest commit 44f42b2a6348cfa1128d00efbc08bf902474172d
Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/66487fd8ea0f6600086639c6
Deploy Preview https://deploy-preview-5532--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 site configuration.

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 5.73%. Comparing base (7bcba29) to head (44f42b2).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5532/graphs/tree.svg?width=650&height=150&src=pr&token=BaET4V1BdM&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js)](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5532?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) ```diff @@ Coverage Diff @@ ## develop #5532 +/- ## ======================================= Coverage 5.73% 5.73% ======================================= Files 277 277 Lines 41988 41988 Branches 515 515 ======================================= Hits 2409 2409 Misses 39579 39579 ``` | [Flag](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5532/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) | Coverage Ξ” | | |---|---|---| | [unit](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5532/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) | `5.73% <0.00%> (ΓΈ)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5532?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) | Coverage Ξ” | | |---|---|---| | [packages/mermaid/src/docs/.vitepress/config.ts](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5532?src=pr&el=tree&filepath=packages%2Fmermaid%2Fsrc%2Fdocs%2F.vitepress%2Fconfig.ts&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js#diff-cGFja2FnZXMvbWVybWFpZC9zcmMvZG9jcy8udml0ZXByZXNzL2NvbmZpZy50cw==) | `0.00% <0.00%> (ΓΈ)` | |
TWiStErRob commented 1 month ago

@sidharthv96 is develop broken?

mermaid-bot[bot] commented 1 month ago

@TWiStErRob, 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.

sidharthv96 commented 1 month ago

The E2E tests are a bit flaky, with the baseline images used. Been planning to look into it, but didn't get time yet. πŸ˜