技术编辑:鸣飞 发自北京
SegmentFault 思否报道 | 公众号:SegmentFault
SegmentFault 思否消息:Rust 核心开发组成员 Steve Klabnik 在官方博客宣布Rust 文档团队暂停。
Steve Klabnik 提到早在 2016 年 8 月组成了一个团队来负责 Rust 文档的相关工作。这个团队主要负责的内容如下:
- 标准库文档
- 相关图书和其他长篇文档
- Cargo 文档
- 错误索引
此外,文档编制团队会以几种方式提供有关生态系统文档编制的帮助。首先,以咨询的身份:帮助希望为自己提供更好文档的人们了解如何实现该目标。此外,监视整个生态系统文档,并确定可为所有 Rustaceans 做出贡献并产生巨大影响的地方。如果 Rust 项目本身具有出色的文档,但是生态系统具有糟糕的文档,那么人们仍然会对 Rust 的文档状况感到沮丧。需要明确的是,这并不意味着拥有生态系统文档,而是要致力于以更多方式做出贡献,而不仅仅是 Rust 项目本身。
当时,所有这些都是非常需要的。使用 Rust 的人还不多,并且没有那么多的文档。
但是文档是一件有趣的事。这确实是一个跨领域的问题。从长远来看,一个团队为其他大量团队编写文档并没有真正的用处。短期而言,这是绝对必要且良好的策略。
让我们再次看一下那些原始资源的现状:
- 标准库的文档已基本填写完毕,当添加新的 API 时,libs 团队将编写一些初始文档。
- 相关图书由史蒂夫和卡罗尔(Steve and Carol)维护。
- Cargo 的文档是 Cargo 团队的职责。
- 错误索引描述了编译器错误,因此这是编译器团队的工作。
Rust 文档团队还添加了以下内容:
- Rust 使用示例
-
rustc
图书和rustc
指南 - 参考手册
- The Rustonomicon
Steve Klabnik 在文章中提到:『一直以来,团队成员并没有真正扩大。我尝试了几次让人们参与其中,但是大多数人只是不喜欢写文档。在这一点上,唯一真正写文档的人是我,最近我也没有很多时间。因此,自 2018 年 8 月以来,我们还没有召开过文档团队会议。这些天也没有真正的讨论过 RFC 文档。因此,此博客文章并没有真正宣布文档团队的结束,而只是描述了今天已经存在的事实。我将继续在核心和本书上进行工作。我计划将来再提交一些文档 PR。我要感谢过去在团队中的每个人,以及多年来提交文档 PR 的每个人。很多人真的很喜欢Rust的文档,没有你们所有人就不可能实现。』
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。