Skip to content

Commit

Permalink
Merge pull request #1739 from BastianZim/develop
Browse files Browse the repository at this point in the history
Updated docs
  • Loading branch information
knsv committed Oct 22, 2020
2 parents 3c2e8cb + cff55e9 commit 3f60107
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Expand Up @@ -196,8 +196,8 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc
## Examples can be found in [Getting Started](getting-started/n00b-gettingStarted.md)

# Sibling projects
- [Mermaid Live Editor](https://github.com/mermaidjs/mermaid-live-editor)
- [Mermaid CLI](https://github.com/mermaidjs/mermaid.cli)
- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)

Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials-and-community/development.md
Expand Up @@ -14,7 +14,7 @@ Here are a few things to know to get you started on the right path.

**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md)**

**Note:You will have to edit the document to see its contents. Commits and PR's should be directed to the develop branch.**
**Note: You will have to edit the document to see its contents. Commits and PR's should be directed to the develop branch.**

## Branching

Expand Down Expand Up @@ -51,9 +51,9 @@ If it is not in the documentation, it's like it never happened. Wouldn't that be

The docs are located in the `docs` folder and are written in MarkDown. Just pick the right section and start typing. If you want to propose changes to the structure of the documentation:

**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md). Click edit it to see them.
**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md). Click edit it to see them.**

The contents of http://mermaid-js.github.io/mermaid/ are based on the docs from **Master** Branch.
The contents of [https://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) are based on the docs from **Master** Branch.

## How to Contribute to Docs

Expand Down Expand Up @@ -121,7 +121,7 @@ Finally, if it is not in the documentation, no one will know about it and then *

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://mermaid-js.github.io/mermaid/ once released the updates are commited to https://mermaid-js.github.io/#/
The changes in master is reflected in [https://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) once released the updates are commited to [https://mermaid-js.github.io/#/](https://mermaid-js.github.io/mermaid/#/).

### Questions and/or suggestions ?
After logging in at [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22).
Expand Down

0 comments on commit 3f60107

Please sign in to comment.