Tokio 文档推进计划（我们需要你！）

过去，一直有反馈认为 Tokio 难以理解。我相信缺乏良好的文档是其中一个重要原因。现在是时候解决这个问题了。

而且因为 Tokio 是开源的，所以这取决于我们（社区）来实现它！👏

但别担心，这并不是一个漫无目的的文档贡献请求。 然而，这确实需要参与。无论您之前有多少 Tokio 经验，都有参与的方式。

Tokio 文档推进

以下是计划。一个临时的代码仓库 doc-push 已经建立，文档工作将在这里协调进行。README 文件中有入门步骤。大致来说，流程将是

1. 阅读现有的文档，跟踪那些令人困惑或留下疑问的部分。

2. 在 doc-push 代码仓库上打开 issue 来报告困惑之处。

3. 修复问题。

4. 重复。

这里的 “修复问题” 指的是修复现有的指南或编写新的指南。

编写新的指南

为了启动编写新指南的工作，doc-push 代码仓库已经用一个 大纲 进行了初始化，这个大纲代表了我对指南应该如何构建的最佳猜测。

任何人都可以自愿从这个大纲中编写一个页面。只需提交一个 PR，在页面旁边添加您的 Github 用户名即可。例如，如果您想自愿编写关于超时的指南，您需要提交一个 PR，更新 section，将 状态：未分配 更改为 状态：已分配 (@myname)。

此外，非常感谢您对大纲结构的反馈和建议。请针对大纲打开 issue 和 PR。

还有一个新的 Gitter 频道专门用于文档推进。如果您想参与，但需要一些指导。请加入频道并 ping 我们。也许您想尝试编写指南，但还不太有信心胜任这项任务。Ping 我们，我们将帮助您完成。

一项实验

文档推进是一项实验。我不知道它会如何发展，但我希望它会成功。

这也是一项迭代的工作。一旦完成一轮改进指南的工作，我们需要回到步骤 1），让新的使用者尝试使用新的文档来学习 Tokio。这将暴露新的差距，需要解决。

常见问题解答

我还不太了解 Tokio！

首先，这不是一个问题。

其次，太棒了！您正是我们想要参与的人。我们需要新鲜的视角来审阅指南，并报告他们遇到的问题。

您可以做的事情

• 阅读现有的指南并报告 issue。
• 为 cookbook 或 “gotchas” 部分集思广益。
• 审阅并提供对 网站的 PR 的反馈。

我想贡献指南，但我不太确定我是否能够

仍然不是一个问题！

您知道他们所说的：“教学是最好的学习方式”。这是一个学习 Tokio 的绝佳机会。首先，有一些大纲可以帮助您入门。这些大纲可能会让您产生疑问或需要一些指导。也许您需要在编写指南之前先学习这个主题！

我们正在 Gitter 频道中热切等待帮助您。我们将帮助您学习您需要学习的知识。作为回报，您将贡献一份指南 😊。

总结

这是您帮助使 Tokio 更容易学习的机会。如果没有人自愿参与文档推进，这一切就不会发生。简而言之

1. 加入 Gitter。

2. 关注 代码仓库。

3. 参与进来！