新闻中心

Filecoin刚刚获得了大规模的Spec升级

发布时间:2020-10-14

10.14.1_副本.jpg

在过去的几个月中,官方在修订Filecoin spec和自定义网站方面取得了巨大的进展!大量的更新使得规格比以前精确了6倍以上,完成度达到了85%,并且许多其他细节已经在进行中。由于新的工作流程,状态标记,搜索等,对spec的贡献和咨询得到了显著改善。

如果您最近没有访问Filecoin Spec网站,请访问:https ://spec.filecoin.io/,可以看到一个全新的网站,其中包含更新的内容!

10.14.2_副本.jpg

这个Spec网站经过了几轮的“设计→实施→部署”,为Filecoin开发人员,实施人员,研究人员和生态系统开发人员创建出色平台所需的所有功能。此外,官方降低了更新spec内容所需的复杂性,应用了结构化的依存关系管理,添加了确保整个spec一致性的功能,增加了对新工具的支持等等!

新的Filecoin spec贡献工作流程

现在,更新spec内容变得更加简单和有趣,涉及在降价文件中进行“单触”编辑。后端机制负责其余的工作,并自动更新目录(ToC)和文档结构!您可以找到所需的所有简单说明,以对spec的repo README文件作出贡献。

更新后的网站最值得注意的功能分为以下几类:

工具和语法:

使用npm和Go模块无缝控制依赖关系

通过katex提供无缝数学支持

带有一些自定义绒线规则的新标记绒线,以确保内容标记的一致性,它作为测试在CI中运行。

图表和代码块:

Mermaid和Dot处理管道(可以选择将来添加更多)与Hugo服务器很好地集成在一起,用于开发和内容编辑。

代码可以使用符号短代码从spec中引用,这样即使代码基本身被修改,正确的代码块也会被引用并从相应的存储库中提取出来。

文档层次结构:

从ToC中提取节编号,以便在重新组织节时自动更新ToC。无需编辑单独的文件即可保持同步。

节深层链接集成。

单页呈现现在稳定了,部分结构也反映在ToC中。

除了这些背景变化之外,该网站也进行了改版!

10.14.3_副本.jpg

在内容方面,官方在更新协议说明方面付出了巨大的努力。Filecoin是一个巨大的项目。从透视的角度来看,如果将其印刷,该协议的spec将是一本约400页的教科书!

Filecoin spec与实现无关,这意味着该文本很好地描述了使网络正常运行的算法和协议交互,而没有涉及实现细节。该spec提供了开发人员以任何语言实现Filecoin所需的所有必需详细信息。仅在需要时提供对Lotus实现的引用。

测量进度

在为期3个月的Spec Project历程中,开放了300多个GitHub问题,并合并了200多个PR。

10.14.4_副本.jpg

如今,spec网站已更新了84%。为了跟踪进度以及网站和协议的“健康”状态,官方整合了三种出色的工具:

1.一个明亮的仪表盘显示了spec中每个部分的“不正确”、“在成品/草案”、“可靠”和“稳定”的状态。官方在spec markdown文件中集成了前端物质属性,以将这些值自动输入到仪表板中,而无需执行任何其他操作。还值得注意的是,仪表板是从ToC自动生成和更新的。无需编辑单独的文件即可更新仪表板!

10.14.5_副本.jpg

2.“审核完成”指示器,作为指示板的一列,显示协议的特定组件是否已被审核。如果有审计报告,则存在指向该报告(或以前的报告列表)的链接以及进行审计的日期。

10.14.6.png

稳定进度条,用于总结整个spec的状态。

10.14.7.png

4.一个单独的“实施状态”仪表板,其中包含所有不同Filecoin实现的状态信息:Lotus,Fuhon,Forest和go-filecoin。仪表板集成了挂钩,以无缝地从相应的存储库中提取信息,并报告CI测试成功/失败以及测试覆盖率。

10.14.8_副本.png

FIP整合

经过几轮测试和两次令人印象深刻的太空竞赛之后,该协议现已进行了微调,准备发射了!从现在起,将通过Filecoin改进提案(FIP)对协议进行更改。建议对协议进行的更改必须经过明确指定的过程,该过程在FIP存储库中进行了详细说明。

在大多数情况下,FIP将需要更新协议spec,因此,正在进行的工作之一包括将Filecoin Spec与FIP流程无缝集成。

接下来

官方还集成了spec版本控制,以创建spec本身的Time Machine,以便您可以及时查看协议更新之前的spec。最后但同样重要的是,官方正在集成工具以通过API代理从远程源中提取数据。这将实现与FIP的无缝集成,但也将能够扩展仪表板,使其包括“一致性测试”的状态。

如果您是Filecoin开发人员,研究员,矿工或用户,官方非常喜欢:

您的帮助有助于spec

您对网站和spec更新过程的反馈

关于如何进一步改善用户体验的想法

在两轮太空竞赛中,协议和spec已取得重大进展,并进行了升级,因此,现在需要付出更多的努力才能将Filecoin的所有spec仪表板单元涂成蓝色!官方计划在接下来的几周内拥有90%的可靠内容,并在接下来的几个月内拥有100%的稳定内容。

9.22.1介绍图.jpg

技术支持:创设网络