Alaya网络上线以来 ,我们收到很多开发者和用户关于文档不齐备、英文缺乏、内容错误的反馈。为了响应大家的问题,也为了后续黑客松和其他活动的顺利开展,我们近期已着手进行Alaya文档的全面优化。也希望社区开发者和用户一起参与,不断完善文档、提升体验。
新版文档的临时仓库: https://github.com/luo-dahui/alaya-devdocs/tree/v2
Alaya文档库改进计划:https://shimo.im/sheets/8Nk6M2anN4hlZ6qL/MODOC/
你可以做什么?
1、Workshop教程制作
我们列了一些教程开发的主题,更多详情请参考:https://shimo.im/docs/1lq7MXbZ6nuQvpAe
- Alaya Dapp开发快速指南,包含环境工具准备,流程,示例教程讲解
- 基于Alaya IDE(PlatON Studio)的WASM,Solidity智能合约开发和部署教程(入门及进阶教程)
- 基于Alaya truffle的WASM,Solidity智能合约开发和部署教程(入门及进阶教程)
- Alaya JS SDK介绍、使用方法,示例教程讲解
- Alaya Python SDK介绍、使用方法,示例教程讲解
- Alaya Java SDK介绍、使用方法,示例教程讲解
- 以太坊应用快速迁移Alaya的案例教程
- Samurai API如何与Dapp进行集成,示例教程讲解
- Alaya账户、交易编程模型介绍说明
2、实例和参考实现
各种实例和参考实现教程,如基于Alaya网络的投票,NFT,众筹,隐私DEX等实例教程…
3、补充优化文档
你可以直接点击每篇文档下方的"编辑"按钮来修改优化文档,通过提交Pull Request的方式来提交缺失的文档。
4、 文档校验
在我们的文档中不乏会出现各种错误,如语言不通畅、命令错误、 错别字、教程错误、信息不完善等各种问题,希望大家若有发现问题,及时反馈给我们,也可自行提交PR。
最后, 这里有一个针对Alaya网络的文档库改进计划:https://shimo.im/sheets/8Nk6M2anN4hlZ6qL/MODOC/ ,在这里我们列出了我们所需的Alaya文档,提出您认为不合理的需要优化的地方,我们共同改进。
你将得到什么?
我们将根据完成任务的工作量和复杂度,给予100ATP到2000ATP不等的奖励。
招募进展
1、开发教程Workshop:
- Stephen Kusu(尼日利亚):将进行 Alaya Python SDK 介绍、使用指导,示例教程讲解
2、文档校验
- dolphintwo: 将进行主网、开发网、私有网络相关操作文档的验证与优化,目前已完成,待提交
- rileyge:JS SDK使用教程文档编写,进行中。Alaya账户介绍和生成指南文档编写,完成初稿,优化中
- JeriZhang:Python SDK使用教程文档编写,进行中
- XING: 基于Alaya的WASM智能合约开发教程,进行中
参与贡献
欢迎各位社区伙伴参与贡献(贡献指南)。任何问题欢迎在本帖、Discord、及邮件(developer@latticex.foundation)获取支持。