New documentation setup (#1708)
* initial docsite setup * switch from pushd to cd * install and set up solidity-docgen * use the docsite branch next for now * make it clear that env var is a repository * add a clarifying comment about a relative path * change relative to absolute path in docsite script * add docgen script * add first few READMEs for contract documentation * update solidity-docgen * add docsite as dependency and adjust script * update openzeppelin-docsite * update solidity-docgen * remove dummy text * update docgen and docsite * update openzeppelin-docsite * add netlify.toml * udpate tokens guide for 2.2 * add DOCUMENTATION.md * Update docs/learn-about-utilities.md Co-Authored-By: frangio <frangio.1@gmail.com> * fix PaymentSplitter docs wording * update solidity-docgen * add missing ERC20 contracts * update solidity-docgen * trigger deploy with cleared cache * update solidity-docgen * update openzeppelin-docsite * remove travis docs setup * update openzeppelin-docsite * switch to published solidity-docgen
This commit is contained in:
committed by
GitHub
parent
412cdfd0be
commit
ed5652b0aa
7
contracts/access/README.md
Normal file
7
contracts/access/README.md
Normal file
@ -0,0 +1,7 @@
|
||||
---
|
||||
sections:
|
||||
- title: Library
|
||||
contracts:
|
||||
- Roles
|
||||
- subdirectory: roles
|
||||
---
|
||||
11
contracts/crowdsale/README.md
Normal file
11
contracts/crowdsale/README.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Crowdsales
|
||||
sections:
|
||||
- title: Core
|
||||
contracts:
|
||||
- Crowdsale
|
||||
- subdirectory: emission
|
||||
- subdirectory: price
|
||||
- subdirectory: validation
|
||||
- subdirectory: distribution
|
||||
---
|
||||
@ -5,7 +5,7 @@ import "../math/SafeMath.sol";
|
||||
/**
|
||||
* @title PaymentSplitter
|
||||
* @dev This contract allows to split Ether payments among a group of accounts. The sender does not need to be aware
|
||||
* that the Ether will be split in this way, since it is handled purely by the contract.
|
||||
* that the Ether will be split in this way, since it is handled transparently by the contract.
|
||||
*
|
||||
* The split can be in equal parts or in any other arbitrary proportion. The way this is specified is by assigning each
|
||||
* account to a number of shares. Of all the Ether that this contract receives, each account will then be able to claim
|
||||
|
||||
18
contracts/token/ERC20/README.md
Normal file
18
contracts/token/ERC20/README.md
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
sections:
|
||||
- title: Interfaces
|
||||
contracts:
|
||||
- IERC20
|
||||
- title: Contracts
|
||||
contracts:
|
||||
- ERC20
|
||||
- ERC20Detailed
|
||||
- ERC20Mintable
|
||||
- ERC20Burnable
|
||||
- ERC20Capped
|
||||
- ERC20Pausable
|
||||
- title: Utilities
|
||||
contracts:
|
||||
- SafeERC20
|
||||
- TokenTimelock
|
||||
---
|
||||
Reference in New Issue
Block a user