quorum/docs
fixanoid 0aa358e2ba
Documentation updates for genesis samples to reflect latest code updates (#952)
2020-03-10 15:10:33 -04:00
..
Cakeshop Fixes markdown bullet formatting for cakeshop getting started 2020-01-15 15:23:11 -05:00
Consensus Fix broken raft consensus link (#940) 2020-02-11 15:22:51 -05:00
Features Support Quorum import export chain (#946) 2020-03-02 16:28:40 -05:00
Getting Started Documentation updates for genesis samples to reflect latest code updates (#952) 2020-03-10 15:10:33 -04:00
How-To-Guides Create tutorial for adding Quorum nodes (#925) 2020-01-23 13:40:57 -05:00
Permissioning Updated permissions documentation to remove inactive status for accounts. Modified contract to fix issue with suborg id when node is added to sub orgs (#950) 2020-03-10 11:08:14 -04:00
PluggableArchitecture docs: fix broken link (#949) 2020-03-03 14:06:27 -05:00
Privacy Merge branch 'master' into docs/AWSSecretsManagerKeyVault 2020-02-10 15:35:15 +00: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
images
theme
FAQ.md docs(tessera): CLI and configfile updates (#929) 2020-02-10 10:30:38 -05:00
Quorum Design.png
Quorum Whitepaper v0.2.pdf
Quorum_Equity_Use_Case.png
README.md
ZSL-Quorum-POC_Protocol_v0_4.png
ZSL.md
conf.py
index.md
private-abigen.md
requirements.txt Framework that allows adding additional Quorum features as plugins (#923) 2020-02-28 15:19:08 -05:00
roadmap.md

README.md

Documentation Status

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