marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-25 18:30:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

add TBD/comments in 'Contribute to Documentation....' section

Browse Source
This commit is contained in:
Ashley Engelund (weedySeaDragon @ github)
2022-11-03 22:29:48 -07:00
parent dabda9d4ef
commit 5eee76764d
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
vdocs/community/development.md
View File

@@ -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.