From a7d0d414b2a6025a65d6dda2fdca1a95f2e0da19 Mon Sep 17 00:00:00 2001 From: Nikolay Rozhkov Date: Thu, 4 Jan 2024 03:56:45 +0300 Subject: [PATCH] Small reorganizing --- docs/community/contributing.md | 16 +++++++++------- .../mermaid/src/docs/community/contributing.md | 18 ++++++++++-------- 2 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/community/contributing.md b/docs/community/contributing.md index 5eb17ead9..0110e7145 100644 --- a/docs/community/contributing.md +++ b/docs/community/contributing.md @@ -312,13 +312,13 @@ To start working with the e2e tests: **Host** - Run `pnpm dev` to start the dev server -- Start **Cypress** by running `pnpm cypress:open`. +- Start **Cypress** by running `pnpm cypress:open` **Docker** - Enable local connections for x11 server `xhost +local:` - Run `./run pnpm dev` to start the dev server -- Start **Cypress** by running `./run pnpm cypress:open --project .`. +- Start **Cypress** by running `./run pnpm cypress:open --project .` The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress. @@ -402,11 +402,6 @@ flowchart LR source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be publised on Official Website"] ``` -### Enable Github Actions - -> **Warning** -> So as to allow automatic compilation of documentation pages you have to enable github actions on your fork first - ### Running the Documentation Website Locally **[The mermaid documentation site](https://mermaid.js.org/) is powered by [Vitepress](https://vitepress.vuejs.org/).** @@ -479,6 +474,13 @@ This is a danger alert If you want to propose changes to how the documentation is _organized_, such as adding a new section or re-arranging or renaming a section, you must update the **sidebar navigation**, which is defined in [the vitepress config](../.vitepress/config.ts). The same goes to **topbar**. +### Build Docs + +The content of `/docs` folder is built with Github Actions. + +> **Warning** +> So as to allow automatic compilation of documentation pages you have to enable Github Actions on your fork first + ## Submit your pull request > **Note** diff --git a/packages/mermaid/src/docs/community/contributing.md b/packages/mermaid/src/docs/community/contributing.md index 71a4f4b2d..5dcf012b8 100644 --- a/packages/mermaid/src/docs/community/contributing.md +++ b/packages/mermaid/src/docs/community/contributing.md @@ -313,13 +313,13 @@ To start working with the e2e tests: **Host** - Run `pnpm dev` to start the dev server -- Start **Cypress** by running `pnpm cypress:open`. +- Start **Cypress** by running `pnpm cypress:open` **Docker** - Enable local connections for x11 server `xhost +local:` - Run `./run pnpm dev` to start the dev server -- Start **Cypress** by running `./run pnpm cypress:open --project .`. +- Start **Cypress** by running `./run pnpm cypress:open --project .` The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress. @@ -397,12 +397,6 @@ flowchart LR source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be publised on Official Website"] ``` -### Enable Github Actions - -```warning -So as to allow automatic compilation of documentation pages you have to enable github actions on your fork first -``` - ### Running the Documentation Website Locally **[The mermaid documentation site](https://mermaid.js.org/) is powered by [Vitepress](https://vitepress.vuejs.org/).** @@ -480,6 +474,14 @@ This is a danger alert If you want to propose changes to how the documentation is _organized_, such as adding a new section or re-arranging or renaming a section, you must update the **sidebar navigation**, which is defined in [the vitepress config](../.vitepress/config.ts). The same goes to **topbar**. +### Build Docs + +The content of `/docs` folder is built with Github Actions. + +```warning +So as to allow automatic compilation of documentation pages you have to enable Github Actions on your fork first +``` + ## Submit your pull request ````note