OCaml.org 新闻: 2024 年 2 月

欢迎来到 2024 年 2 月版的 OCaml.org 新闻!本期更新由 OCaml.org 团队整理。您可以在 Discuss 上找到 之前的更新

我们的目标是让 OCaml.org 成为任何想要入门并使用 OCaml 高效工作的人的最佳资源。OCaml.org 新闻提供我们朝着这个目标的进展以及我们正在进行的变更的概述。

没有所有帮助我们审查、修订和创建更好的 OCaml 文档的优秀 OCaml 社区成员,我们无法做到这一点。您的反馈使我们能够更好地优先考虑我们的工作。谢谢您!

本期新闻涵盖

  • OCaml 文档: 发布了新的文档,并改进了现有文档。
  • OCaml 食谱: OCaml 食谱的原型,它提供简短的代码示例,使用 OCaml 生态系统中的包来解决实际问题,位于 staging.ocaml.org/cookbook。
  • 黑暗模式: 我们现在几乎准备好发布黑暗模式了。
  • 社区部分重做: 我们正在准备社区部分的线框图,以便更好地展示现有内容。此外,我们开始了面向专门的“活动”页面的初步工作。
  • 通用改进: 和往常一样,我们还根据用户反馈进行了通用维护和改进,因此我们将在下面重点介绍我们的一些工作。

贡献者的开放问题和 Outreachy 申请期

外部贡献者有开放问题。但是,由于 github.com/ocaml/ocaml.org 参与了 Outreachy 申请期,我们可能会在 3 月份出现开放问题短缺,因为 Outreachy 申请者会很快处理它们。

您可以在这里找到 贡献者的开放问题

OCaml 文档

用户测试

21 位勇敢的新手同意在发现 OCaml 的过程中被观察一个小时,并完成一些编程任务。非常感谢参加我们举办的用户测试的所有参与者!

一半的用户测试参与者使用最近 更新的教程,另一半使用 v2.ocaml.org/docs。我们的结论是

  • 学习 OCaml 并不难。然而,学习函数式编程却很难。大多数有先前 FP 经验的参与者成功完成了任务。
  • 更新的文档在教授没有 FP 经验的参与者 OCaml 和 FP 方面比手册略好。其中一些人在使用新的教程时成功完成了更复杂的任务,而所有没有 FP 经验的参与者在使用旧文档时都失败了。

通过观察参与者试图理解任务并在文档中找到相关资料,我们已经确定了许多可能改善文档页面用户体验的较小变更。

相关 PR 和活动

即将推出的 OCaml 食谱

我们在向学习区域添加一个新的社区驱动的部分方面取得了一些进展: OCaml 食谱。食谱旨在成为食谱的集合,提供解决使用 OCaml 生态系统中的包的实际问题的代码示例。

这是我们正在考虑的设计

  • 类别: 任务的高级分组,例如,网络、数据压缩或命令行参数。
  • 任务: 在一个类别中要完成的单一事情,例如,写入文件、进行 HTTP GET 请求或返回退出状态。
  • 食谱: 使用包的任务版本,例如,使用 curlycohttp 进行 HTTP GET。

一个粗略的原型位于 staging.ocaml.org/cookbook。我们收到的贡献和用户反馈表明,食谱的结构需要再次细化,直到它准备好发布。

关于食谱的反馈的最佳位置是 这个 Discuss 线程

相关 PR 和活动

黑暗模式

12 月,oyenuga17 开始在 OCaml.org 上实现新的黑暗模式。

到目前为止,新的黑暗模式已经基本完成,但尚未得到足够的审查或测试。

我们根据您的浏览器/操作系统偏好在 staging.ocaml.org 上启用了黑暗模式。如果您想提供帮助,您可以查看 staging.ocaml.org 上的黑暗模式,并通过打开问题报告您看到的任何内容。

已完成的页面

社区版块重构

本月,我们已经开始对社区区域进行用户研究,并收集了对当前页面的反馈和想法。除此之外,我们还确定了以下几点:

  • 社区版块需要一个更好的活动目录
  • 工作页面需要从社区页面更容易访问
  • 突出显示 OCaml 生态系统中正在寻找贡献者的开源项目会很棒

如果你对社区版块有任何意见,请随时在 这个讨论主题 中分享!

相关 PR 和活动

一般改进

感谢许多帮助在 2 月改进 OCaml.org 的贡献者。下面列出了他们!

相关 PR 和活动