Document ContractKit (based on feedback)

[mcortesi]

Expected Behavior

Feeback to resolve:

• [x] There isn't any comprehensive documentation of all available functions and their signatures and behaviors for contractkit
• [x] There isn't any documentation listing all the core contracts that Celo provides
• There isn't any documentation for creating and deploying smart contracts i.e. kit.web3.eth.Contract(...).deploy(...) (now #1046 )
• [ ] Sending money as described in the ContractKit docs does not work and always results in an error. It is also different from how sending money is implemented in the dAppKit Docs.
• [x] The first line of the sample code in the ContractKit Examples say that we can do const goldtoken = await kit.contract.getGoldToken() but the correct code should be const goldtoken = await kit.contracts.getGoldToken()
• [x] The sample code in the docs have missing imports
• [ ] We couldnt find toTxResult even though it is used in the sample code, nor does it seem to be needed when sending transactions like this const result = await kit.web3.eth.sendSignedTransaction(tx);

[mcortesi]

In progress...

For documentation we will use typedoc, and generate docs form .ts files.

typedoc by default generates an html static site, but in order to integrate it with gitbook I'm using a markdown plugin and having some problems with it.

Waiting for feedback on https://github.com/tgreyuk/typedoc-plugin-markdown/issues/97

[mcortesi]

Partially fixed in #1195