返回新闻

OCaml.org 新闻：2024 年 1 月

欢迎来到 2024 年 1 月的 OCaml.org 新闻简报！本期更新由 OCaml.org 团队编制。您可以在 Discuss 上找到 之前的更新。

我们的目标是让 OCaml.org 成为任何想要开始学习 OCaml 并提高生产力的人的最佳资源。OCaml.org 新闻简报将提供我们朝着这一目标取得的进展的更新以及我们正在进行的更改概述。

如果没有所有帮助我们审查、修改和创建更好的 OCaml 文档的令人惊叹的 OCaml 社区成员，我们无法做到这一点。您的反馈使我们能够更好地优先处理我们的工作。谢谢！

本期新闻简报涵盖

  • OCaml 文档：已发布了新的文档，并对现有文档进行了改进。
  • 暗黑模式：在实现即将推出的暗黑模式方面取得了良好进展。
  • 总体改进：与往常一样，我们还根据用户反馈处理了常规维护和改进，因此我们将在下面重点介绍我们的一些工作。

贡献者开放问题

我们为外部贡献者创建了许多问题。其中大多数适合 OCaml 初学者，我们很乐意审查您的拉取请求并提供反馈！

您可以在 此处找到贡献者开放问题！

OCaml 文档

我们发布了多个新文档，最值得注意的是关于模块、函子、带有 Dune 的库，以及一个关于使用 OCaml.org Playground 的新教程。关于标记参数、集合和选项的文档已得到改进。

为了更好地了解新文档的有效性，我们正在进行用户测试（在 Discuss 和 Twitter/X 上宣布），将 v2.ocaml.org 上的旧文档内容与 ocaml.org 上的新文档进行比较。足够多的 OCaml 新手志愿者帮助我们完成这项工作。非常感谢！

此外，还有一个开放的调查问卷，要求您对新文档相对于旧内容进行评分：我们很乐意收到您对 此调查问卷 的意见，即使您只给我们一些数字评分！

相关 PR 和活动

我们开始打开标记为“需要帮助”的问题，使外部贡献者能够帮助改进文档。反响非常积极，我们很高兴继续这样做，并借助您的帮助，使 OCaml 文档真正出色！

即将推出的暗黑模式

在 12 月，oyenuga17 开始在 OCaml.org 上实现新的暗黑模式。计划是在 3 月初根据浏览器/操作系统首选项完成并激活暗黑模式。看起来我们有望实现这一目标。

我们不断将小补丁合并到 OCaml.org 中，您可以查看 https://staging.ocaml.org 上已完成的暗黑模式页面。我们在页面底部放置了一个按钮，用于在登台环境中切换暗黑模式。（这不会发布。它只是让我们审查暗黑模式页面的方法。）

已完成的页面

总体改进

最显著的更改 TLDR:

  • 我们合并了一个基本的文档搜索功能，以使您能够在 OCaml 文档中搜索。它在 学习区域“概述”页面 上可用！这里还有改进的空间，最值得注意的是添加错别字更正，以及将包和文档搜索统一到顶部导航栏的搜索框中。
  • 已修复一个长期存在的问题，即包文档模块树视图中显示了错误的库名称！
  • 包概述页面现在链接到一个新页面，该页面列出了所有包版本及其发布日期。
  • 更新日志现在可以从主登录页面访问。
  • 我们现在在教程的 Markdown 页面的 YAML 元数据中链接教程的先决条件和推荐的后续教程。这将确保教程之间的这些链接将保持有效。

感谢所有在 1 月份帮助改进 OCaml.org 的贡献者！ 以下是他们的列表！

相关 PR 和活动