status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

contrib: add docs about the diagrams

This commit is contained in:
Daniel Nephin 2021-07-07 13:42:13 -04:00
parent c96991b35d
commit 27c85d8df2
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
contributing/README.md
View File

@ -35,3 +35,18 @@ found in the public [user documentation].
1. [Multi-Cluster Federation](./cluster-federation) 1. [Multi-Cluster Federation](./cluster-federation)
Also see the [FAQ](./faq.md). Also see the [FAQ](./faq.md).
## Contributing to these docs
This section is meta documentation about contributing to these docs.
### Diagrams
The diagrams in these documents are created using the [mermaid-js live editor].
The [mermaid-js docs] provide a complete reference for how to create and edit
the diagrams. Use the [consul-mermaid-theme.json] (paste it into the Config tab
in the editor) to maintain a consistent Consul style for the diagrams.
[mermaid-js live editor]: https://mermaid-js.github.io/mermaid-live-editor/edit/
[mermaid-js docs]: https://mermaid-js.github.io/mermaid/
[consul-mermaid-theme.json]: ./consul-mermaid-theme.json