From f1cea37814ae17f5fb8192c50f1c68eca235d474 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Thu, 1 Oct 2020 18:53:30 -0700 Subject: [PATCH 1/5] Update README.md --- docs/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 11b1772b0..49b1543cd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,23 +9,24 @@ ## About -Mermaid is a Javascript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development. +Mermaid simplifies complex diagrams. It is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. The main purpose of Mermaid is to help Documentation catch up with Development. > Doc-Rot is a Catch-22 that Mermaid helps to solve. Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning.
-Mermaid addresses this problem by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content. -The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). -So less time needs to be spent on documenting, as a separate and laborious task.
+Mermaid addresses this Catch-22 by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content. +Mermaid, as a text-based diagramming tool allows for quick and easy updates, it can also be made part of production scripts (and other pieces of code), to make documentation much easier. +With Mermaid less time needs to be spent on making diagrams, as a separate documentation task.
-Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaidjs/mermaid-live-editor), visit [Mermaid Overview](overview/n00b-overview.md) for the video tutorials. +> Mermaid is a Diagramming tool for everyone. +Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaidjs/mermaid-live-editor), Visit the [Tutorials Page](href='https://github.com/mermaid-js/mermaid/blob/develop/docs/Tutorials.md) for the Live Editor video tutorials. Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](overview/integrations.md). For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](overview/n00b-overview.md) and [Usage](getting-started/usage.md). -🌐 [CDN](https://unpkg.com/mermaid/) | 📖 [Documentation](https://mermaidjs.github.io) | 🙌 [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | 📜 [Version Log](tutorials-and-community/CHANGELOG.md) +🌐 [CDN](https://unpkg.com/mermaid/) | 📖 [Documentation](https://mermaidjs.github.io) | 🙌 [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/tutorials-and-community/development.md) | 📜 [Version Log](tutorials-and-community/CHANGELOG.md) > 🖖 Keep a steady pulse: mermaid needs more Collaborators, [Read More](https://github.com/knsv/mermaid/issues/866). From f6954c898d43deece2a68d91a755794f3d1afc0c Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Thu, 1 Oct 2020 18:53:48 -0700 Subject: [PATCH 2/5] Update README.md --- docs/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/README.md b/docs/README.md index 49b1543cd..7e320ed73 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,6 +20,7 @@ Mermaid, as a text-based diagramming tool allows for quick and easy updates, it With Mermaid less time needs to be spent on making diagrams, as a separate documentation task.
> Mermaid is a Diagramming tool for everyone. + Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaidjs/mermaid-live-editor), Visit the [Tutorials Page](href='https://github.com/mermaid-js/mermaid/blob/develop/docs/Tutorials.md) for the Live Editor video tutorials. Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](overview/integrations.md). From c81eaccfef684c041ed93dd34c2fd769df794d4d Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Mon, 5 Oct 2020 19:03:45 -0700 Subject: [PATCH 3/5] Update newDiagram.md --- docs/tutorials-and-community/newDiagram.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials-and-community/newDiagram.md b/docs/tutorials-and-community/newDiagram.md index 7a53e4c3a..57cf7b19a 100644 --- a/docs/tutorials-and-community/newDiagram.md +++ b/docs/tutorials-and-community/newDiagram.md @@ -1,5 +1,5 @@ --- -sort: 1 +sort: 2 title: Adding a New Diagram/Chart --- From 6d5883630171c79e85439122a1b561b20d316c33 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Mon, 5 Oct 2020 19:37:36 -0700 Subject: [PATCH 4/5] Update _sidebar.md --- docs/assets/_sidebar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/assets/_sidebar.md b/docs/assets/_sidebar.md index 3c78c83cc..0cf7e9d23 100644 --- a/docs/assets/_sidebar.md +++ b/docs/assets/_sidebar.md @@ -19,9 +19,9 @@ - Contributions and Community - - [Adding Diagrams](newDiagram.md) --> + - Diagrams and Syntax and Examples From e9f4d2040b6343f48cbc4258a0273a18d7ba1aa6 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Mon, 5 Oct 2020 19:56:32 -0700 Subject: [PATCH 5/5] Update _sidebar.md --- docs/assets/_sidebar.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/assets/_sidebar.md b/docs/assets/_sidebar.md index 0cf7e9d23..fadb30424 100644 --- a/docs/assets/_sidebar.md +++ b/docs/assets/_sidebar.md @@ -18,9 +18,9 @@ - Contributions and Community - + + + - Diagrams and Syntax and Examples