EPIC: Smart Contract Documentation

[rackstar]

Overview

We need to write documentation for our platform:

• core protocol documentation ⚙️
• system diagrams
• user flows

Audience

This is to be used by other builders that might want to integrate / build on top of our platform (grants, hackathon etc..)

[rackstar]

Tasks

Core Protocol:

Please complete the following order of priority:

• [x] Ramm.sol
• [x] StakingPool.sol
• [x] Pool.sol
• [x] Cover.sol
• [x] StakingProducts.sol
• [ ] StakingFactory.sol @rackstar
• [ ] Assessment.sol @MilGard91
• [ ] IndividualClaims.sol
• [ ] TokenController.sol

System Diagram:

TODO

User Flows:

TODO