Skip to content

Commit 84ad8aa

Browse files
authored
Merge pull request #2041 from beriakomal/patch-1
Changes in sentence structuring for better readability
2 parents 98c0926 + 1238dc2 commit 84ad8aa

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/n00b-overview.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@
22

33
**Explaining with a Diagram**
44

5-
A picture is worth a thousand words, a good diagram is certainly worth more.
5+
A picture is worth a thousand words, a good diagram is undoubtedly worth more. They make understanding easier.
66

77
## Creating and Maintaining Diagrams
88

9-
Anyone who has used Visio, or (God Forbid) Excel to make a Gantt Chart, knows how hard it is to make, edit and maintain good visualizations.
9+
Anyone who has used Visio, or (God Forbid) Excel to make a Gantt Chart, knows how hard it is to create, edit and maintain good visualizations.
1010

11-
Diagrams/Charts are both very important but also become obsolete/inaccurate very fast. This catch-22 hobbles the productivity of teams.
11+
Diagrams/Charts are significant but also become obsolete/inaccurate very fast. This catch-22 hobbles the productivity of teams.
1212

1313
# Doc Rot in Diagrams
1414

1515
Doc-Rot kills diagrams as quickly as it does text, but it takes hours in a desktop application to produce a diagram.
1616

17-
mermaid seeks to change that. mermaid creates diagrams using markdown inspired syntax. The process is quicker, less complicated and more convenient way of going from concept to visualization
17+
Mermaid seeks to change using markdown-inspired syntax. The process is a quicker, less complicated, and more convenient way of going from concept to visualization.
1818

19-
This is a relatively straightforward solution to a major hurdle in software teams.
19+
It is a relatively straightforward solution to a significant hurdle with the software teams.
2020

2121
# Definition of Terms/ Dictionary
2222

2323
**Mermaid text definitions can be saved for later reuse and editing.**
2424

25-
>These are the Mermaid diagram deffinitions inside `<div>` tags, with the `class=mermaid`.
25+
>These are the Mermaid diagram definitions inside `<div>` tags, with the `class=mermaid`.
2626
2727
```html
2828
<div class="mermaid">
@@ -35,33 +35,33 @@ This is a relatively straightforward solution to a major hurdle in software team
3535

3636
**render**
3737

38-
>This is the core function of the Mermaid API, it reads all the `Mermaid Definitions` inside `div` tags and returns an SVG file, based on the definitions.
38+
>This is the core function of the Mermaid API. It reads all the `Mermaid Definitions` inside `div` tags and returns an SVG file, based on the definition.
3939
4040

4141
**Nodes**
4242

43-
>These are the boxes that contain text or otherwise discrete pieces of each diagram, separated generally by arrows, except for Gantt Charts and User Journey Diagrams. They will be referred to often in the instructions. Read for Diagram Specific [Syntax](./n00b-syntaxReference)
43+
>These are the boxes that contain text or otherwise discrete pieces of each diagram, separated generally by arrows, except for Gantt Charts and User Journey Diagrams. They will be referred often in the instructions. Read for Diagram Specific [Syntax](./n00b-syntaxReference)
4444
45-
## Advantages of Using Mermaid
45+
## Advantages of using Mermaid
4646

47-
- Ease of generate, modify and render diagrams, when you make
47+
- Ease to generate, modify and render diagrams when you make them.
4848
- The number of integrations and plugins it has.
49-
- It can be added to your or your company's website.
49+
- You can add it to your or companies website.
5050
- Diagrams can be created through comments like this in a script:
5151

5252
## The catch-22 of Diagrams and Charts:
5353

54-
**Diagramming and charting is a gigantic waste of developer time, but not having diagrams ruins productivity.**
54+
**Diagramming and charting is a large waste of developer's time, but not having diagrams ruins productivity.**
5555

56-
mermaid solves this by cutting the time, effort and tooling that is required to create diagrams and charts.
56+
Mermaid solves this by reducing the timeand effort required to create diagrams and charts.
5757

58-
Because, the text base for 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 be spent on documenting, as a separate task.
58+
Because, the text base for the diagrams allows it to be updated easily. Also, it can be made part of production scripts (and other pieces of code). So less time is spent on documenting, as a separate task.
5959

6060

6161
## Catching up with Development
6262

63-
Being based on markdown, mermaid can be used, not only by accomplished front-end developers, but by most computer savvy people to render diagrams, at much faster speeds.
64-
In fact one can pick up the syntax for it quite easily from the examples given and there are many tutorials in the internet.
63+
Being based on markdown, Mermaid can be used, not only by accomplished front-end developers, but by most computer savvy people to render diagrams, at much faster speeds.
64+
In fact one can pick up the syntax for it quite easily from the examples given and there are many tutorials available in the internet.
6565

6666
## Mermaid is for everyone.
6767
Video [Tutorials](https://mermaid-js.github.io/mermaid/#/./Tutorials) are also available for the mermaid [live editor](https://mermaid-js.github.io/mermaid-live-editor/).

0 commit comments

Comments
 (0)