From 8027a0c55db2a86e495a8223ff37960cb41b234a Mon Sep 17 00:00:00 2001 From: Ted Marozzi Date: Mon, 6 Mar 2023 04:55:59 +1100 Subject: [PATCH] make clearer --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0320b36e..150a22341 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,6 +55,8 @@ The documentation is written in **Markdown**. For more information about Markdow The source files for the project documentation are located in the [`/packages/mermaid/src/docs`](packages/mermaid/src/docs) directory. This is where you should make changes. The files under `/packages/mermaid/src/docs` are processed to generate the published documentation, and the resulting files are put into the `/docs` directory. +After editing files in the [`/packages/mermaid/src/docs`](packages/mermaid/src/docs) directory, be sure to run `pnpm install` and `pnpm run --filter mermaid docs:build` locally to build the `/docs` directory. + ```mermaid flowchart LR classDef default fill:#fff,color:black,stroke:black