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
Docs: Corrects name of C4 link #4660
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4660 +/- ##
===========================================
- Coverage 76.73% 58.00% -18.74%
===========================================
Files 137 51 -86
Lines 16296 8637 -7659
Branches 496 19 -477
===========================================
- Hits 12505 5010 -7495
+ Misses 3677 3627 -50
+ Partials 114 0 -114
Flags with carried forward coverage won't be shown. Click here to find out more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
We might even want to rename the /syntax/c4c.md
file to /syntax/c4.md
, but we'd need to somehow redirect the old URL to the new URL, and I'm not sure how difficult that would be!
Pinging @pinghe (the original author of C4 diagrams), in case they also want to give some feedback!
* master: update latest news section
@Incognito, Thank you for the contribution! |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.2.4` -> `10.3.0`](https://renovatebot.com/diffs/npm/mermaid/10.2.4/10.3.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.2.4/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.2.4/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.3.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.3.0): 10.3.0 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.2.4...v10.3.0) #### What's Changed ##### Features - Sankey diagrams by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4502 - Feature/1838 actor creation destruction by [@​Valentine14th](https://togithub.com/Valentine14th) in [mermaid-js/mermaid#4466 - Vertical branches in Git Diagram by [@​mastersibin](https://togithub.com/mastersibin) in [mermaid-js/mermaid#4639 - Use JSON Schema to define and document `MermaidConfig` by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4112 - Remove the test checking whether the JSON Schema default config matched the old default config by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4610 - Fixes support of the macro `ContainerQueue_Ext` for C4 diagrams definition. by [@​kislerdm](https://togithub.com/kislerdm) in [mermaid-js/mermaid#4577 ##### Bugfixes - Make quadrant chart options TypeScript types optional by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4602 - Remove double parsing by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4587 - Fix flowchart tooltip typing bug by [@​lishid](https://togithub.com/lishid) in [mermaid-js/mermaid#4562 - Bug/4590 allow notes identical to keywords by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4597 - feat: allow specifying on which weekday a tickInterval should start by [@​leinelissen](https://togithub.com/leinelissen) in [mermaid-js/mermaid#4634 - Split formatted markdown strings with unicode support. by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4470 - fix: Mind maps handles `-` signs in node ids/text by [@​knsv](https://togithub.com/knsv) ##### Chores - Remove all TypeScript enums and forbid them in ESLint by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4580 - refactor accessibility by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4551 - chore: Reduce codecov pushes by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4604 - Run PR-labeler-config-validator only if config changes by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4607 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4624 - Update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4566 - Update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4581 - Rename workflow jobs by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4574 - Removed unused code in state diagrams by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4631 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4623 - chore: remove unused `devDependency` on coveralls by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4641 - Allow entity diagram attribute names to start with asterisk by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4588 - Bug/4592 fix new line padding class diagram by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4633 - Fix graph not loading when the img loads too fast or fail to load by [@​pierrickouw](https://togithub.com/pierrickouw) in [mermaid-js/mermaid#4496 - convert `cypress/helpers/util.js` to ts by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4552 - build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 by [@​dependabot](https://togithub.com/dependabot) in [mermaid-js/mermaid#4652 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4663 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4662 ##### Documentation - Sankey: Remove duplicated examples by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4595 - Release docs by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4493 - Update latest news section by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4495 - Fix Typo by [@​ryru](https://togithub.com/ryru) in [mermaid-js/mermaid#4567 - Docs: add ChatGPT plugin blog post by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4570 - Fix relative link to theme variables list by [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4573 - Fix docs:dev by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4598 - Docs: update link - "Join the Community" by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4601 - Support docs:dev in docker by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4599 - docs(flowchart): add documentation on multiple nodes style by [@​tomperr](https://togithub.com/tomperr) in [mermaid-js/mermaid#4600 - Avoid downloading avtars everytime on docs:dev by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4603 - docs: Fix checkbox syntax by [@​guilhermgonzaga](https://togithub.com/guilhermgonzaga) in [mermaid-js/mermaid#4646 - Fix the "Edit this page on GitHub" link in Vitepress documentation for the Mermaid Config pages by [@​aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4640 - Support MERMAID_RELEASE_VERSION in docs. by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4612 - Docs: update Latest News section by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4655 - added Typora to integrations list by [@​kgilbert78](https://togithub.com/kgilbert78) in [mermaid-js/mermaid#4666 - Docs: Corrects name of C4 link by [@​Incognito](https://togithub.com/Incognito) in [mermaid-js/mermaid#4660 - Fix a typo by [@​gjtorikian](https://togithub.com/gjtorikian) in [mermaid-js/mermaid#4396 #### New Contributors - [@​ryru](https://togithub.com/ryru) made their first contribution in [mermaid-js/mermaid#4567 - [@​ibrahimWassouf](https://togithub.com/ibrahimWassouf) made their first contribution in [mermaid-js/mermaid#4573 - [@​kislerdm](https://togithub.com/kislerdm) made their first contribution in [mermaid-js/mermaid#4577 - [@​leinelissen](https://togithub.com/leinelissen) made their first contribution in [mermaid-js/mermaid#4634 - [@​pierrickouw](https://togithub.com/pierrickouw) made their first contribution in [mermaid-js/mermaid#4496 - [@​mastersibin](https://togithub.com/mastersibin) made their first contribution in [mermaid-js/mermaid#4639 - [@​kgilbert78](https://togithub.com/kgilbert78) made their first contribution in [mermaid-js/mermaid#4666 - [@​Incognito](https://togithub.com/Incognito) made their first contribution in [mermaid-js/mermaid#4660 - [@​gjtorikian](https://togithub.com/gjtorikian) made their first contribution in [mermaid-js/mermaid#4396 **Full Changelog**: mermaid-js/mermaid@v10.2.4...v10.3.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/levaintech/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMS4wIiwidXBkYXRlZEluVmVyIjoiMzYuMTEuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@Incognito @aloisklink |
📑 Summary
Corrects "C4C Diagram" to "C4 Diagram". If you don't know enough about C4 and the history of changes I've summarized all the context you need to know below here. I think this is important because Mermaid is quite popular and this may lead people to believe the diagramming model is really called "C4C" instead of "C4". Additionally, it may look like Mermaid doesn't support C4 as people are expecting find C4.
Context:
C4 is a technique to model and diagram architecture at 4 levels (context, containers, components & code -- this is why it has the name "C4"), and there are additional views on it that can be taken too (dynamic, deployment)
The Existing implementation in Mermaid's C4 Models covers these implementations (as per Mermaid docs):
I believe that the original contributor called it C4C to indicate that this feature only supported context diagrams (which is why
(context)
is added in the title and the C was added to the end of C4) but this is no longer true. It was true in the initial commit 113efd1 13 months ago. Mermaid now supports the majority of C4 levels.The title was corrected from C4C to C4 in the c4c.md file in commit 0c5b494 (merged in 0c5b4948 shortly afterwards but not in the
docs/_sidebar.md
which has since been replaced with this file. The old name was carried forward automatically ine34e2087 Add auto generated docs
11 months ago and has remained ever since.