2011 年 6 月 2 日星期四

文档方面的最新动向

作者:fxn

新的配置指南

Rails 3.1 将随附一本由 Ryan Bigg(@ryanbigg)编写的全面指导手册,介绍如何配置 Rails 应用程序。当前草案已经 在边缘指南中提供

Rails 文档团队

大约三年前成立的文档团队由 Pratik Naik(@lifo)、Mike Gunderloy(@MikeG1)和我组成,他们在引导文档库方面发挥了重要作用。还有许多 API 贡献者和指南编写者。向 Pratik 和 Mike 致敬,他们的努力非常出色,有力地推进了该项工程的这一方面的进展。

这么多年来,一直在在 master 版本中定期维护文档。正因如此,我们不再设置一个独立的文档团队。我们也不设置一个独立的测试团队。测试和文档是 Ruby on Rails 的组成部分,完整的补丁程序具有或应该具有适当的测试和文档内容。

Rails 指南评论员

审查指南需要特殊的简介和奉献,有自己的标准和进度。将成立一个指南审查团队,负责新材料。我非常高兴地宣布 Vijay Dev(@vijay_dev)将成为该团队的第一位成员。过去几个月来,Vijay 在文档库中做了很多出色工作。欢迎他加入 :)。

后续步骤

过去几年来,Rails 文档有了很大改进,内容更多,编辑质量也更高。但仍有很多工作要做。以下是一些可以改进的点

  • 一个新的文档生成器,可评估源代码树并进行内省以生成 API,再加上一个解析器以提取文档片段。

  • API 中的方法包含一个链接,用于切换其源代码的可见性。如果有一个切换器可显示其测试,岂不更棒?

  • 指南的测试覆盖率。

  • 华丽的模板设计如何?

如果您想针对这些中的任何一个进行黑客攻击,请继续!