github.com/hyperion-hyn/go-ethereum@v2.4.0+incompatible/docs/README.md (about)

     1  [![Documentation Status](https://readthedocs.org/projects/goquorum/badge/?version=latest)](http://docs.goquorum.com/en/latest/?badge=latest)
     2  
     3  # Quorum documentation
     4  
     5  New Quorum documentation is now published on https://docs.goquorum.com/
     6  
     7  ## How to contribute
     8  
     9  Quorum documentation files are written in Markdown and configured with a
    10  YAML configuration file from [mkdocs](https://www.mkdocs.org/)
    11  
    12  The documentation site uses [Material theme](https://squidfunk.github.io/mkdocs-material/)
    13  which has been configured with number of theme [extensions](https://squidfunk.github.io/mkdocs-material/extensions/admonition/)
    14  to enhance documenting experience 
    15  
    16  To contribute, here is 3 simple steps
    17  
    18  - Use Python to install `mkdocs` and related dependencies
    19      ```bash
    20      pip install -r requirements.txt
    21      ```
    22  - Add/Modify desired documentation files and preview the site
    23      ```bash
    24      mkdocs serve
    25      ```
    26  - Commit and raise PR against master