From 5eee76764d4b5394e6836b6bc9dbfa0162cd9823 Mon Sep 17 00:00:00 2001 From: "Ashley Engelund (weedySeaDragon @ github)" Date: Thu, 3 Nov 2022 22:29:48 -0700 Subject: [PATCH] add TBD/comments in 'Contribute to Documentation....' section --- vdocs/community/development.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/vdocs/community/development.md b/vdocs/community/development.md index fd70d0a72..453e86db8 100644 --- a/vdocs/community/development.md +++ b/vdocs/community/development.md @@ -210,10 +210,16 @@ Updates committed to the `master` branch are reflected in the [Mermaid Docs](htt ### How to Contribute to Documentation +**_[Note: This entire section needs to be updated.]_** + We are a little less strict here, it is OK to commit directly in the `develop` branch if you are a collaborator. The documentation is located in the `src/docs` directory and organized according to relevant subfolder. +_- documentation is now in `vdocs/....`_ + +_- how to run the vdocs server (explain vdoc tasks in package.json)_ + **The Docs Structure is dictated by [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/src/docs/_sidebar.md)** The `docs` folder will be automatically generated when committing to `src/docs` and should not be edited manually.