首页 IPFS 正文

Filecoin已完成大规模Spec升级!

2020-10-14 14:52:01 来源:IPFS灵动社区 作者:IPFS灵动社区 阅读:628 涉及币种: Filecoin
   
Filecoin网络进度情况一览~
  专业专注    共建共赢  
在过去的几个月中,开发团队在修订Filecoin规范及其自定义网站方面取得了巨大进展!有无数的更新,这使规格比以前精确了6倍以上,达到了85%的完整性评分,并且许多其他细节已经在进行中。由于新的工作流程,所以状态标记,搜索操作规范等诸多方面得到了显着改善。
如果您最近没有访问Filecoin Spec网站,请转至:https ://spec.filecoin.io/,以查看一个经过全面翻新的网站,其中包含更新的内容!
Spec网站经过了几轮“设计→实施→部署”,以整合Filecoin开发人员,实施人员,研究人员和生态系统开发人员创建出色平台所需的所有功能。此外,我们降低了更新规范内容所需的复杂性,应用了结构化的依存关系管理,添加了确保整个规范一致性的功能,增加了对新工具的支持等等!
新的Filecoin规范贡献工作流程
现在,更新规范内容变得更加简单和有趣,涉及在降价文件中进行“单触”编辑。后端机制负责其余的工作,并自动更新目录(ToC)和文档结构!您可以找到所需的所有简单说明,以对规范的repo README文件作出贡献。
更新后的站点最值得注意的功能分为以下几类:
1. 工具和语法
  • 使用npm和Go模块无缝控制依赖关系

  • 通过katex提供无缝数学支持

  • 新的markdown,带有一些自定义的规则,以确保内容降价的一致性,该内容在CI中作为测试运行。

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

  • 可以使用符号短代码从规范中引用代码,以便即使修改了代码库本身,也可以引用正确的代码块并将其从相应的存储库中提取。

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

  • 深层链接集成。

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

除了这些背景变化之外,该网站也进行了改版!
在内容方面,我们在更新协议说明方面付出了巨大的努力。Filecoin是一个巨大的项目。从透视的角度来看,如果将其印刷,该协议的规范将是一本约400页的教科书!
Filecoin规范与实现无关,这意味着该文本很好地描述了使网络正常运行的算法和协议交互,而没有涉及实现细节。该规范提供了开发人员以任何语言实现Filecoin所需的所有必需详细信息。仅在需要时提供对Lotus实现的引用。
测量进度
在为期3个月的Spec Project历程中,开放了300多个GitHub问题,并合并了200多个PR。
如今,规范站点已更新了84%。为了跟踪我们自己的进度以及站点和协议的“健康”状态,我们结合了三种出色的工具:
明亮的仪表板:以“不正确”,“在制品/草稿”,“可靠”和“稳定”的范围显示规范各部分的状态。我们在spec markdown文件中集成了前端物质属性,以将这些值自动输入到仪表板中,而无需执行任何其他操作。还值得注意的是,仪表板是从ToC自动生成和更新的。无需编辑单独的文件即可更新仪表板!
“审核完成”指示符:作为仪表板的单独列,以显示协议的特定组件是否已被审核。如果有审计报告,则存在指向该报告(或以前的报告列表)的链接以及进行审计的日期。
1. 稳定进度条,用于总结整个规范的状态。
2. 一个单独的“实施状态”仪表板。
其中包含所有不同Filecoin实现的状态信息:Lotus,Fuhon,Forest和go-filecoin。仪表板集成了挂钩,以无缝地从相应的存储库中提取信息,并报告CI测试成功/失败以及测试覆盖率。
FIP整合
经过几轮测试和两次令人印象深刻的太空竞赛之后,该协议现已进行了微调,正准备实施方案!从现在起,将通过Filecoin改进提案(FIP)对协议进行更改。建议对协议进行的更改必须经过明确指定的过程,该过程在FIP存储库中进行了详细说明。
在大多数情况下,FIP将需要更新协议规范,因此,我们正在进行的工作之一包括将Filecoin Spec与FIP流程无缝集成。
下一步动向
我们还集成了规范版本控制,以创建规范本身的Time Machine,以便您可以及时查看协议更新之前的规范。最后但同样重要的是,我们正在集成工具以通过API代理从远程源中提取数据。这将实现与FIP的无缝集成,但也将使我们能够扩展仪表板,使其包括“一致性测试”的状态。
如果您是Filecoin开发人员,研究员,链上节点或用户,我们将非常乐意:
  • 您的帮助有助于规范

  • 您对网站和规范更新过程的反馈

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

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


声明:此文出于传递更多信息之目的,并不意味着赞同其观点或证实其描述。本网站所提供的信息,只供参考之用。

TOPS
  • 最热/
  • 周排行/
  • 月排行