tomaz-suller / iden3-docs

iden3 documentation

Iden3 Documentation

Overview

This repository contains the source code for the iden3 documentation website.

The website is generated and deployed using readthedocs.

The actual website is available at docs.iden3.io.

Licensing

The content of this website is available under CC BY-SA 4.0.

The surrounding source code is available under GPL-3.0.

All contributions will fall under theses two licenses based on the type of contribution.

Building And Offline Use

The documentation website can easily be built locally either for offline use or for contribution purposes.

1. Download/clone github repository

   git clone https://github.com/iden3/iden3-docs.git
   cd iden3-docs

2. Install Readthedocs and dependencies.

   pip install -r requirements.txt
   sudo apt-get update
   sudo apt-get install pandoc pandoc-citeproc

3. Collect iden3 documentation scattered across several repos.

   make doc

4. Build documentation

   make html

5. Preview documentation located in build/html/index.html.

Contributing

Anyone is welcome to contribute to the documentation by submitting pull requests to this repository.

Please read the contribution guidelines first, to allow for smooth collaboration. There is also a FAQ document providing further guidelines