History

vsmk98 3edbfc1e2d Merge branch 'master' into fix/raft-cluster-api		2020-02-01 12:55:43 +08:00
..
Cakeshop	Fixes markdown bullet formatting for cakeshop getting started	2020-01-15 15:23:11 -05:00
Consensus	added api documentation for raft apis.	2020-01-31 12:26:25 +08:00
Features	Update DNS document for raft (#912 )	2019-12-13 08:33:09 -05:00
Getting Started	Updating examples with broader samples (#816 )	2019-09-11 10:13:39 -04:00
How-To-Guides	Create tutorial for adding Quorum nodes (#925 )	2020-01-23 13:40:57 -05:00
Permissioning	permission: removed unnecessary mux from permissions_cache.go, added additional unit test for permissions cache, code clean up and documentation change	2019-09-09 15:53:15 +08:00
Privacy	Tessera release documentation update. (#914 )	2019-12-17 09:10:58 -05:00
RemixPlugin	Removes .swp file	2019-12-10 15:52:28 -05:00
Security/Framework	fix typo (#930 )	2020-01-29 11:43:12 -05:00
Transaction Processing	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
images	Merge remote-tracking branch 'remotes/upstream/master' into feature/permissioning-1.8.18-suborgs-docs	2019-08-06 11:48:12 +08:00
theme	Add logo favicon and other minor doc fixes/changes: (#723 )	2019-05-23 18:37:52 -04:00
FAQ.md	Docs: Raft and Tessera key config update (#832 )	2019-10-01 13:02:14 -04:00
Quorum Design.png	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
Quorum Whitepaper v0.2.pdf	Documentation wording and formatting changes (#492 )	2018-08-24 09:08:02 -04:00
Quorum_Equity_Use_Case.png	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
README.md	added how-to-contribute (#736 )	2019-06-10 15:25:00 -04:00
ZSL-Quorum-POC_Protocol_v0_4.png	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
ZSL.md	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
conf.py	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
index.md	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
private-abigen.md	Quorum private transaction support for Abigen (#819 )	2019-10-01 12:49:26 -04:00
requirements.txt	pin mkdocs-material version to fix the missing search bar (#905 )	2019-12-05 11:20:08 -05:00
roadmap.md	Docs updates (#735 )	2019-06-10 10:42:20 -04:00

README.md

Quorum documentation

New Quorum documentation is now published on https://docs.goquorum.com/

How to contribute

Quorum documentation files are written in Markdown and configured with a YAML configuration file from mkdocs

The documentation site uses Material theme which has been configured with number of theme extensions to enhance documenting experience

To contribute, here is 3 simple steps

Use Python to install mkdocs and related dependencies
```
pip install -r requirements.txt
```
Add/Modify desired documentation files and preview the site
```
mkdocs serve
```
Commit and raise PR against master