PlatON文档库验收计划

社区伙伴们:

​ 大家好,在开源世界,一份完备且让大多数开发者体验良好的开发者文档总是可遇而不可求,大家擅长的技能不尽相同,导致由极少部分人撰写的文档并不能满足大部分开发者的诉求。PlatON作为技术开源社区,通过文档的方式对我们的使命、愿景、技术等进行传播,是完善和丰富开发者生态的重要方式,好的文档可以降低大家对PlatON的认知成本,为涌现创新提供基石,基于此,文档体验的重要性不言而喻。

出于对文档的重视,我们现推出文档库验收计划,鼓励更多的开发者参与到内容的写作中,与更多开发者近距离的对话,希望文档库像开源代码一样,在广大开发者的协作下,不断完善文档、提升体验。

如何参与

不积跬步无以至千里,不积小流无以成江海。PlatON生态的繁荣离不开社区小伙伴、开发者们的共同努力,你们提交的每一个ISSUE、PR都将为PlatON生态注入一份养料。你可以从文档意见反馈入手,优化改写、进阶贡献实例、分析源码和案例等,与社区共同成长,让我们一起见证你的每一个付出和收获。

方式一:反馈问题

阅读文档过程中,对于任何问题或者疑问,通过在GitHub上提交Issue的方式直接反馈意见。高质量的问题反馈有助于我们不断完善文档内容和质量,您提供的信息越详尽,对我们问题改进越有帮助。

方式二:问题修复

当你在文档使用过程中发现错误或者不合理的地方,可以在文档页面中单击“编辑”按钮,即可跳转到相应GitHub仓库,针对现有文档进行快速更改和修复,该方式适合少量内容修改和补充。

方式三:创建新内容

鼓励开发者在学习、开发过程中,总结经验并创建技术内容帮助更多开发者快速上手。推荐输出各类How to教程、常见问题FAQ等。

方式四:文档翻译

​ 可以翻译缺失的文档,也可以对现有英文文档内容进行校正。

作为Contributor有哪些回馈

成为活跃贡献者,有机会获取相应的LAT奖励和头衔。我们后续会推出奖励细节,除了LAT奖励,我们会在基金会论坛文档专栏表彰公示,并有机会受邀参加社区见面会等活动。

PlatON文档库链接

6 Likes

收到,每天关注项目进度

1 Like

每天关注项目进度,积极线下布道

1 Like

大家手机上这个“英文“是什么样子?
建议把文档库链接入口放进公众号“云图百科”里

能不能搞个论坛app

能不能在质押退时,信息通知一下,谢谢

这个是文档框架里面的一个玩意儿。。我们看看怎么去掉这个东东。。。