Spec网站已整合了开发人员、实施人员和研究人员所需的所有功能。此外,还降低了更新规范内容的复杂性,应用了结构化的依存关系管理,添加了确保整个规范一致性的功能,并增加了对新工具的支持等等!网站已经全面翻新,请访问:https://spec.filecoin.io/
新的Filecoin规范贡献工作流程现在,更新规范内容变得更简单和有趣,只需要在文件中进行"单触"编辑。后端机制负责其余的工作,并自动更新目录(ToC)和文档结构!更新后的站点最显著的功能分为以下几类:- 工具和语法:使用npm和Go模块无缝控制依赖关系,通过katex提供无缝数学支持,新的markdownlinter带有自定义lint规则,以确保内容一致性,内容降价在CI中用于开发和内容编辑。可以使用符号短代码从规范中引用代码,即使修改了代码库本身,也可以引用正确的代码块并从相应的存储库中提取。- 文件层级:从ToC中提取节编号,以在重组节后自动更新ToC。无需编辑单独的文件即可保持同步。节深层链接集成。现在,单页呈现稳定并在ToC中反映了部分结构。
除了这些背景变化之外,该网站也进行了改版!
在内容方面,我们为更新协议说明付出了巨大的努力。Filecoin是一个庞大的项目。从透视的角度来看,如果将其印刷出来,该协议的规范将是一本约400页的教科书!Filecoin规范与实现无关,这意味着该文本很好地描述了使网络正常运行的算法和协议交互,而没有涉及实现细节。该规范提供了开发人员以任何语言实现Filecoin所需的所有必要详细信息,仅在需要时提供对Lotus实现的引用。
测量进度在为期3个月的SpecProject历程中,我们开放了300多个GitHub问题,并合并了200多个PR。如今,规范站点已更新了84%。为了跟踪我们自己的进度以及站点和协议的状态,我们结合了三种出色的工具:1. 明亮的仪表板,以“不正确”、“在制品/草稿”、“可靠”和“稳定”的范围显示规范各部分的状态。我们在specmarkdown文件中集成了前端物质属性,以将这些值自动输入到仪表板中,无需执行任何其他操作。还值得注意的是,仪表板是从ToC自动生成和更新的,无需编辑单独的文件即可更新仪表板!2. “审核完成”指示符作为仪表板的单独列,以显示协议的特定组件是否已被审核。如果有审计报告,则存在指向该报告(或以前的报告列表)的链接以及进行审计的日期。3. 稳定进度条,用于总结整个规范的状态。4. 一个单独的“实施状态”仪表板,其中包含所有不同Filecoin实现的状态信息:Lotus,Fuhon,Forest和go-filecoin。仪表板集成了挂钩,以无缝地从相应的存储库中提取信息,并报告CI测试的成功/失败以及测试覆盖率。
FIP整合经过几轮测试和两次令人印象深刻的太空竞赛之后,该协议现已进行了微调,可以开始发射了!从现在起,将通过Filecoin改进提案(FIP)对协议进行更改。建议对协议进行的更改必须经过明确指定的过程,该过程在FIP存储库中有详细说明。在大多数情况下,FIP将需要更新协议规范,因此,我们正在进行的工作之一是将FilecoinSpec与FIP流程无缝集成。
下一步是什么?我们还集成了规范版本控制,以创建规范本身的TimeMachine,以便您可以及时查看协议更新之前的规范。最后但同样重要的是,我们正在集成工具以通过API代理从远程源中提取数据。这将实现与FIP的无缝集成,并使我们能够扩展仪表板,使其包括“一致性测试”的状态。
在两轮太空竞赛中,协议及其规范已取得重大进展,并进行了升级,因此,现在需要付出更多的努力才能将Filecoin的所有规范仪表板单元涂成蓝色(完成既定工作计划)!我们计划在接下来的几周内拥有90%的可靠内容,并在接下来的几个月内拥有100%的稳定内容。
END
注:本文内容仅供学习参考,不构成投资建议。如有任何疑问,请加官方客服微信号HQAL001咨询。
本站所有软件信息均由用户上传发布,版权归原著所有。如有侵权/违规内容,敬请来信告知邮箱:764327034@qq.com,我们将及时撤销! 转载请注明出处:https://czxurui.com/zx/57996.html
发表回复
评论列表(0条)