-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Restore API Contract Documentation to v5 #982
Comments
I should certainly add a lot more (especially providers vs signers), but here is what is currently in the v5 docs: https://docs.ethers.io/v5/api/contract/contract/#Contract-connect Is there any specific wording of the v4 docs You want maintained or ported over? |
Maybe bring back the code samples. Only the sentences in the actual documentations are very poor to understand. I know is hard to write all this alone. I would do my best to improve the documentation because the samples are very very important to the students |
I've finally got around to updating this page, which should hopefully cover everything you need. :) During docs generation, the page deploys a simple ERC20-like contract to a local Geth instance and each code example interacts with it, so it should be quite true-to-life. If there is anything missing, please let me know. :) Thanks! :) |
Wow. It was a huge improvement. Thank you very much! However, I know it could sound silly but the comprehensive example showing how to connect to a provider and to a signer it is even more important to a new student to allowing them to be able to read/write in a Contract. These are few more lines but I assure you it is going to help a lot. Would you please mind adding these lines too?
and
|
As I give classes about DApp development ethers.js documentation is important to the students and to all new DApp developers. One of most useful sections is
https://docs.ethers.io/v4/api-contract.html?highlight=value#connecting-to-existing-contracts
This documentation, if I am not mistaken, is missing at v5 documentation.
Could you please include it? Or could you give instructions how to help you to include it in the new version documentation?
Thanks in advance
The text was updated successfully, but these errors were encountered: