...
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
andHow to
section - Code the possible placeholders documentation for
Concepts
andTutorials
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)
...