From 0506ba872a54e1490af3372af91dff8c245c69c9 Mon Sep 17 00:00:00 2001 From: Nikolay Rozhkov Date: Sun, 17 Dec 2023 13:35:49 +0300 Subject: [PATCH] Fixed linters --- packages/mermaid/src/docs/community/docker-setup.md | 4 +--- packages/mermaid/src/docs/community/intro.md | 11 +++++------ packages/mermaid/src/docs/community/setup.md | 2 +- packages/mermaid/src/docs/community/workflow.md | 6 +++--- 4 files changed, 10 insertions(+), 13 deletions(-) diff --git a/packages/mermaid/src/docs/community/docker-setup.md b/packages/mermaid/src/docs/community/docker-setup.md index 753c1d4b9d..6e6d421ca9 100644 --- a/packages/mermaid/src/docs/community/docker-setup.md +++ b/packages/mermaid/src/docs/community/docker-setup.md @@ -9,7 +9,7 @@ Initial setup consists of 3 main steps:: ```mermaid-nocode flowchart LR source --> requirements --> setup - + source[Get the source code] requirements[Install the requirements] setup[Setup and launch] @@ -104,5 +104,3 @@ pnpm test The `test` script and others are in the top-level `package.json` file. All tests should run successfully without any errors or failures. (You might see _lint_ or _formatting_ warnings; those are ok during this step.) - - diff --git a/packages/mermaid/src/docs/community/intro.md b/packages/mermaid/src/docs/community/intro.md index 633282b145..3d618d1531 100644 --- a/packages/mermaid/src/docs/community/intro.md +++ b/packages/mermaid/src/docs/community/intro.md @@ -35,15 +35,14 @@ mindmap ## Where do I start? -* You could confirm the bugs in [these issues](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug+%2F+Error%22+label%3A%22Status%3A+Pending%22). -* You could help write and improve the documentation! [Here's ](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Help+wanted%21%22+label%3A%22Area%3A+Documentation%22)some inspiration. -* You could start getting some knowledge of the code base by working on [these "good first issues"](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22+). -* You could jump right in and help us fix any of [these bugs](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug+%2F+Error%22+label%3A%22Help+wanted%21%22+label%3A%22Area%3A+Development%22)! -* You could work on a new feature! [These](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Development%22+label%3A%22Help+wanted%21%22+label%3A%22Type%3A+Enhancement%22+label%3A%22Status%3A+Approved%22) are some ideas! +- You could confirm the bugs in [these issues](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug+%2F+Error%22+label%3A%22Status%3A+Pending%22). +- You could help write and improve the documentation! [Here's ](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Help+wanted%21%22+label%3A%22Area%3A+Documentation%22)some inspiration. +- You could start getting some knowledge of the code base by working on [these "good first issues"](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22+). +- You could jump right in and help us fix any of [these bugs](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug+%2F+Error%22+label%3A%22Help+wanted%21%22+label%3A%22Area%3A+Development%22)! +- You could work on a new feature! [These](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Development%22+label%3A%22Help+wanted%21%22+label%3A%22Type%3A+Enhancement%22+label%3A%22Status%3A+Approved%22) are some ideas! Detailed information about contributing can be found in the [contribution guide](https://github.com/mermaid-js/mermaid/blob/master/CONTRIBUTING.md). - ## Last Words Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So, if you get stuck, ask for help and hints in the Slack forum. If you want to show off something good, show it off there. diff --git a/packages/mermaid/src/docs/community/setup.md b/packages/mermaid/src/docs/community/setup.md index 2545d315a8..ac087ad9e5 100644 --- a/packages/mermaid/src/docs/community/setup.md +++ b/packages/mermaid/src/docs/community/setup.md @@ -9,7 +9,7 @@ Initial setup consists of 3 main steps: ```mermaid-nocode flowchart LR source --> requirements --> setup - + source[Get the source code] requirements[Install the requirements] setup[Setup and launch] diff --git a/packages/mermaid/src/docs/community/workflow.md b/packages/mermaid/src/docs/community/workflow.md index 313fd10787..ad19789538 100644 --- a/packages/mermaid/src/docs/community/workflow.md +++ b/packages/mermaid/src/docs/community/workflow.md @@ -69,15 +69,14 @@ flowchart LR slash --> 1123 --> underscore underscore --> short_description_1 underscore --> short_description_2 - + underscore["_"] slash["/"] - + short_description_1["state-diagram-new-arrow-florbs"] short_description_2["fix_random_ugly_red_text"] ``` - If your work is specific to a single diagram type, it is a good idea to put the diagram type at the start of the description. This will help us keep release notes organized by a diagram type. ```note @@ -116,6 +115,7 @@ In case in its description contains a [magic comment](https://docs.github.com/en ``` Resolves # ``` + You can edit it if needed. ## Congratulations