...

Description 

There is a need to improve the current status of Hyperledger Cacti documentation. Thus by adopting a new material design and moving the existing docs to the new design schema is necessary.

Additional Information

We can refer to this template or the Hyperledger Besu documenation and use that material design in Hyperledger Cacti docs with the help of Sphinx tool.

Milestones

(Each milestone is set to be achieved in 2 weeks time, subject to be changed upon creation of the actual project plan)

•  Understand the existing Cactus codebase - Part 1
•  Understand the existing Cactus whitepapers and documentation - Part 2
•  Break the entire available documentation (with placeholders for the missing ones) into 5 categories, Get Started , How to , Concepts , Tutorials , References and host the placeholder docs on ReadTheDocs.org
•  Code the existing documentation for the Get Started  section
•  Code the existing  documentation for the How to  section
•  Code the  existing documentation for the Concepts  section
•  Code the existing documentation for the Tutorials  section
•  Code the existing documentation for the References  section
•  Code the possible placeholders documentation for Get Started  and How to  section
•  Code the possible placeholders documentation for Concepts  and Tutorials  section
•  Code the possible placeholders documentation for References section and anything to catchup from prior sections
•  Create docs PR, ReadTheDocs page and the final presentation/demo related to this project

Learning Objectives

Sphinx, Hyperledger Cacti, ReadTheDocs.org (host the docs here, just like Hyperledger Bevel docs)

Expected Outcome

Complete transfer of our root docs and every package docs to ReadTheDocs, with the above mentioned material theme and the color matching the Cacti  text color present in the logo.

Relation to Hyperledger 

Hyperledger Cacti

Mentee Skills

• Sphinx
• ReadTheDocs
• Ability to learn and understand the current Hyperledger Cacti documentation

Future plans

The documentation contributed via this project will act as the go-to documentation for Hyperledger Cacti

Mentor(s) Names and Contact Info

Peter Somogyvari, Accenture, Discord ID: peter_somogyvari#3365

Suvajit Sarkar , Accenture, Discord ID: ssark#4224

Jagpreet Singh Sasan ,  Accenture, Discord ID: axetacular#2402