rusk
rusk copied to clipboard
Create smart contract documentation
Epic - Create smart contract documentation
Summary
Create documentation for the Piecrust/Rusk smart contract platform to enable third-party developers to build and deploy smart contracts while ensuring they follow best practices and are aware of any platform caveats.
Tasks
- [ ] Write an intro to the smart contract platform
- [ ] Develop a getting started guide
- [ ] Create a detailed "language" guide covering syntax we use (like [no_mangle]), available types and structures
- [ ] Describe common smart contracts, use cases and best practices
- [ ] Document contract modules and libraries, including host functions
- [ ] Provide guidance on testing and debugging
- [ ] Define the host functions and what is available
- [ ] Explain deployment and upgrade strategies for smart contracts
- [ ] Dive into advanced topics like custom circuits and optimizations
- [ ] Create a comprehensive API reference
Benefits
Once this epic is done developers will be provided with a clear understanding of how smart contracts work in the context of Dusk, making it easier for them to get started, build, test and deploy smart contracts. It will also be a way to promote best practices and security guidelines, ensuring the overall quality of Dusk contracts Well-structured and good documentation will foster a strong developer community, encouraging adoption of the platform.