search

RiskProtocol / core-protocol

1 stars 0 forks source link

Tech documentation #109

Open mz7mz7mz7 opened 1 year ago

mz7mz7mz7 commented 1 year ago

  1. Find a tool to change a) Solidity in-line comments and b) MD documentation files into good-looking HTML or PDF tech documentation. This will be provided to security auditors to facilitate their process.

  2. Add extensive documentation to Solidity functions, explaining their purpose, how they work, and also interconnection between the functions. Add also a bit of business/overview context in the MD files.

haidarally commented 11 months ago

Some Tools

  1. https://github.com/ItsNickBarry/hardhat-docgen
  2. https://github.com/OpenZeppelin/solidity-docgen

for Natspec comments

haidarally commented 9 months ago

High level docs: https://docs.google.com/document/d/1yIjdjTiMebQTeYiSUdpAOo8dHjtugBYECC0XAmoB8uM/edit

Inline commenst: ft-comments