Skip to content

Commit cee2a45

Browse files
nirnamenirname
committed
Fixed docs according review
Update docs
1 parent 7b45dbe commit cee2a45

File tree

10 files changed

+39
-27
lines changed

10 files changed

+39
-27
lines changed

‎docs/community/docker-development.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ Then you **clone** a copy to your local development machine (e.g. where you code
3434
3535
[Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need.
3636

37-
Optionally, to run GUI (Cypress) within Docker you will also need X11 server installed.
38-
Maybe you already have it installed, so check it first:
37+
Optionally, to run GUI (Cypress) within Docker you will also need an X11 server installed.
38+
You might already have it installed, so check this by running:
3939

4040
```bash
4141
echo $DISPLAY
4242
```
4343

44-
If variable `$DISPLAY` is not empty, then it must be working. Otherwise install it.
44+
If the `$DISPLAY` variable is not empty, then an X11 server is running. Otherwise you may need to install one.
4545

4646
## Setup and Launch
4747

‎docs/community/documentation.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ flowchart LR
4242
You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box.
4343
Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
4444

45-
````
45+
````markdown
4646
```note
4747
Note content
4848
```
@@ -58,11 +58,10 @@ Warning content
5858
```danger
5959
Danger content
6060
```
61-
6261
````
6362

6463
> **Note**
65-
> If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch.
64+
> If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch. In that case, your branch should be based on master, not develop.
6665
6766
We encourage contributions to the documentation at [packages/mermaid/src/docs in the _develop_ branch](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs).
6867

@@ -87,7 +86,7 @@ _\[TODO: need to keep this in sync with [check out a git branch in Contributing
8786
2. Find the Markdown file (.md) to edit in the `packages/mermaid/src/docs` directory.
8887
3. Make changes or add new documentation.
8988
4. Commit changes to your branch and push it to GitHub (which should create a new branch).
90-
5. Create a Pull Request of your fork.
89+
5. Create a Pull Request from the branch of your fork.
9190

9291
To edit Docs on GitHub:
9392

‎docs/community/questionsAndSuggestions.md renamed to ‎docs/community/questions-and-suggestions.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
>
33
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
44
>
5-
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/questionsAndSuggestions.md](../../packages/mermaid/src/docs/community/questionsAndSuggestions.md).
5+
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/questions-and-suggestions.md](../../packages/mermaid/src/docs/community/questions-and-suggestions.md).
66
77
# Questions or Suggestions?
88

@@ -24,5 +24,3 @@ Feel free to add to the discussion on the issue or topic.
2424
If you can't find anything that already addresses your question or suggestion, _open a new issue:_
2525

2626
Log in to [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22).
27-
28-
## How to Contribute a Suggestion

‎docs/intro/index.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,14 @@ It is a JavaScript based diagramming and charting tool that renders Markdown-ins
1616

1717
<div class='badges'>
1818

19-
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
19+
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml)
20+
[![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid)
21+
[![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid)
22+
[![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master)
23+
[![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid)
24+
[![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid)
25+
[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
26+
[![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
2027

2128
</div>
2229

@@ -322,7 +329,6 @@ To Deploy Mermaid:
322329
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
323330
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
324331
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)
325-
- [HTTP Server](https://github.com/TomWright/mermaid-server)
326332

327333
## Request for Assistance
328334

@@ -343,7 +349,9 @@ Don't hesitate to contact me if you want to get involved!
343349

344350
<div class='badges'>
345351

346-
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
352+
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22)
353+
[![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
354+
[![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
347355

348356
</div>
349357

@@ -428,6 +436,7 @@ _Mermaid was created by Knut Sveidqvist for easier documentation._
428436
.badges > p {
429437
display: flex;
430438
}
439+
431440
.badges > p > a {
432441
margin: 0 0.5rem;
433442
}

‎packages/mermaid/src/docs/.vitepress/config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ function sidebarCommunity() {
196196
{ text: 'Contributing to Mermaid', link: '/community/development' },
197197
{ text: 'Contributing Code', link: '/community/code' },
198198
{ text: 'Contributing Documentation', link: '/community/documentation' },
199-
{ text: 'Questions and Suggestions', link: '/community/questionsAndSuggestions' },
199+
{ text: 'Questions and Suggestions', link: '/community/questions-and-suggestions' },
200200
{ text: 'Adding Diagrams', link: '/community/newDiagram' },
201201
{ text: 'Security', link: '/community/security' },
202202
],

‎packages/mermaid/src/docs/.vitepress/theme/redirect.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const idRedirectMap: Record<string, string> = {
4949
'more-pages': '',
5050
'n00b-advanced': 'config/n00b-advanced',
5151
'n00b-gettingstarted': 'intro/n00b-gettingStarted',
52-
'n00b-overview': 'community/n00b-overview',
52+
'n00b-overview': 'intro/n00b-gettingStarted',
5353
'community/n00b-overview': 'intro/n00b-gettingStarted',
5454
'n00b-syntaxreference': 'intro/n00b-syntaxReference',
5555
newdiagram: 'community/newDiagram',

‎packages/mermaid/src/docs/community/docker-development.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Then you **clone** a copy to your local development machine (e.g. where you code
2828
2929
[Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need.
3030

31-
Optionally, to run GUI (Cypress) within Docker you will also need X11 server installed.
32-
Maybe you already have it installed, so check it first:
31+
Optionally, to run GUI (Cypress) within Docker you will also need an X11 server installed.
32+
You might already have it installed, so check this by running:
3333

3434
```bash
3535
echo $DISPLAY
3636
```
3737

38-
If variable `$DISPLAY` is not empty, then it must be working. Otherwise install it.
38+
If the `$DISPLAY` variable is not empty, then an X11 server is running. Otherwise you may need to install one.
3939

4040
## Setup and Launch
4141

‎packages/mermaid/src/docs/community/documentation.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ flowchart LR
2828
You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box.
2929
Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
3030

31-
````
31+
````markdown
3232
```note
3333
Note content
3434
```
@@ -44,11 +44,10 @@ Warning content
4444
```danger
4545
Danger content
4646
```
47-
4847
````
4948

5049
```note
51-
If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch.
50+
If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch. In that case, your branch should be based on master, not develop.
5251
```
5352

5453
We encourage contributions to the documentation at [packages/mermaid/src/docs in the _develop_ branch](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs).
@@ -74,7 +73,7 @@ _[TODO: need to keep this in sync with [check out a git branch in Contributing C
7473
2. Find the Markdown file (.md) to edit in the `packages/mermaid/src/docs` directory.
7574
3. Make changes or add new documentation.
7675
4. Commit changes to your branch and push it to GitHub (which should create a new branch).
77-
5. Create a Pull Request of your fork.
76+
5. Create a Pull Request from the branch of your fork.
7877

7978
To edit Docs on GitHub:
8079

‎packages/mermaid/src/docs/community/questionsAndSuggestions.md renamed to ‎packages/mermaid/src/docs/community/questions-and-suggestions.md

-2
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,3 @@ Feel free to add to the discussion on the issue or topic.
1818
If you can't find anything that already addresses your question or suggestion, _open a new issue:_
1919

2020
Log in to [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22).
21-
22-
## How to Contribute a Suggestion

‎packages/mermaid/src/docs/intro/index.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@ It is a JavaScript based diagramming and charting tool that renders Markdown-ins
1010

1111
<div class='badges'>
1212

13-
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
13+
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml)
14+
[![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid)
15+
[![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid)
16+
[![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master)
17+
[![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid)
18+
[![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid)
19+
[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
20+
[![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
1421

1522
</div>
1623

@@ -99,7 +106,6 @@ To Deploy Mermaid:
99106
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
100107
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
101108
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)
102-
- [HTTP Server](https://github.com/TomWright/mermaid-server)
103109

104110
## Request for Assistance
105111

@@ -120,7 +126,9 @@ Don't hesitate to contact me if you want to get involved!
120126

121127
<div class='badges'>
122128

123-
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
129+
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22)
130+
[![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
131+
[![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
124132

125133
</div>
126134

@@ -205,6 +213,7 @@ _Mermaid was created by Knut Sveidqvist for easier documentation._
205213
.badges > p {
206214
display: flex;
207215
}
216+
208217
.badges > p > a {
209218
margin: 0 0.5rem;
210219
}

0 commit comments

Comments
 (0)