From bdb530f8318c8c7502dc7c46a97f93711bfe081f Mon Sep 17 00:00:00 2001 From: Knut Sveidqvist Date: Fri, 11 Oct 2019 08:17:47 +0200 Subject: [PATCH] Adding more info about documentation and moving the contributing file to its proper place --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9a28d807..20d6cbf30 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,6 +84,10 @@ This is what a rendering test looks like: Finally, if it is not in the documentation, no one will now about it and then **no one will use it**. Wouldn't that be sad? With all effort that was put into the feature? +The docs are located in the docs folder and are ofc written in markdown. Just pick the right section and start typing. If you want to add to the structure as in adding a new section and new file you do that via the _navbar.md. + +The changes in master is reflected in http://knsv.github.io/mermaid/ once released the updates are commited to https://mermaidjs.github.io/#/ + ## Last words Don't get daunted if it is hard in the beginning. We have a great community with only enouraging 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.