quorum/docs
Trung Nguyen 40fd5207dd
merged with master
2019-09-12 10:00:59 -04:00
..
Cakeshop Updating examples with broader samples (#816) 2019-09-11 10:13:39 -04:00
Consensus Reorganize raft faq (#804) 2019-08-27 19:14:22 +02:00
Getting Started Updating examples with broader samples (#816) 2019-09-11 10:13:39 -04: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 permission: corrected documentation structure 2019-09-06 11:05:55 +08:00
Security/Framework permission: corrected documentation structure 2019-09-06 11:05:55 +08: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 Reorganize raft faq (#804) 2019-08-27 19:14:22 +02: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
requirements.txt Quorum documentation update (#701) 2019-05-02 12:38:58 -04: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