quorum/docs
Sai V dcab518e50
update documentation to include maxCodeSizeConfig documentation. (#1006)
2020-05-29 09:17:40 -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
Getting Started update documentation to include maxCodeSizeConfig documentation. (#1006) 2020-05-29 09:17:40 -04:00
How-To-Guides Quorum geth upgrade to 1.9.7 (#960) 2020-04-29 10:50:56 -04:00
Permissioning Update links 2020-05-14 10:59:19 -04:00
PluggableArchitecture docs: fix broken link (#949) 2020-03-03 14:06:27 -05:00
Privacy Quorum Documentation Update (#996) 2020-05-12 15:42:08 -04:00
Quorum Features Quorum Documentation Update (#996) 2020-05-12 15:42:08 -04:00
RemixPlugin Updating Quorum inviter links (#976) 2020-04-20 16:33:47 -04:00
Security/Framework Quorum Documentation Update (#996) 2020-05-12 15:42:08 -04:00
Wizard Quorum Documentation Update (#996) 2020-05-12 15:42:08 -04:00
audits Quorum geth upgrade to 1.9.7 (#960) 2020-04-29 10:50:56 -04:00
images Adding qubernetes to quorum README.md / docs. (#970) 2020-04-10 13:57:01 -04:00
quorum.js Fix broken link (#998) 2020-05-13 09:15:49 -04:00
theme Quorum Documentation Update (#996) 2020-05-12 15:42:08 -04:00
FAQ.md Quorum geth upgrade to 1.9.7 (#960) 2020-04-29 10:50:56 -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
README.md added how-to-contribute (#736) 2019-06-10 15:25:00 -04:00
conf.py Quorum documentation update (#701) 2019-05-02 12:38:58 -04:00
index.md Update Tessera encryption & Privacy Manager docs (#972) 2020-04-18 13:24:34 -04:00
private-abigen.md Quorum private transaction support for Abigen (#819) 2019-10-01 12:49:26 -04:00
requirements.txt Framework that allows adding additional Quorum features as plugins (#923) 2020-02-28 15:19:08 -05:00
roadmap.md Docs updates (#735) 2019-06-10 10:42:20 -04:00

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