mirror of https://github.com/poanetwork/quorum.git
1ae7b23f9d
Co-Authored-By: chris-j-h <39617426+chris-j-h@users.noreply.github.com> |
||
---|---|---|
.. | ||
Cakeshop | ||
Consensus | ||
Features | ||
Getting Started | ||
Permissioning | ||
Privacy | ||
RemixPlugin | ||
Security/Framework | ||
Transaction Processing | ||
images | ||
theme | ||
FAQ.md | ||
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 | ||
roadmap.md |
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 dependenciespip install -r requirements.txt
- Add/Modify desired documentation files and preview the site
mkdocs serve
- Commit and raise PR against master