OCaml.org 新闻简报:2023 年 5 月
欢迎来到 2023 年 5 月版的 OCaml.org 新闻简报!与 之前的更新 一样,这份新闻简报由 @sabine 和 @tmattio 编写。
OCaml.org 新闻简报概述了 OCaml.org 网站的变化,并让你了解幕后发生的事情。你可以在这里找到 以前的新闻简报列表。
我们的目标是让 OCaml.org 成为任何想要入门并高效使用 OCaml 的最佳资源。如果没有所有帮助我们审查、修改和创建更好的 OCaml 文档的 OCaml 社区成员,我们无法做到这一点。你们的反馈使我们能够更好地优先考虑工作,并朝着我们的目标取得进展。谢谢!
我们将在三个部分展示本月我们所做的工作。
- 学习区:我们正在努力让 OCaml.org 成为学习 OCaml 和探索其生态系统的绝佳资源。本月,我们完成了新的学习区域的第一个线框图,并发布了一些新的文档页面。
- 包文档搜索:现在 OCaml.org 上的每个包都可以进行包内搜索!我们发布了该功能的第一个最小版本,并将继续在未来几个月对其进行改进。
- 一般改进:我们还致力于进行一般维护和改进。我们将在本新闻简报中重点介绍其中的一些改进。
学习区
1. 学习区的重新设计
作为我们努力使 OCaml.org 成为学习 OCaml 的绝佳资源的一部分,我们在 4 月发布了一项调查,以进行用户研究。我们收到了大量的有见地的反馈。本月,我们分析了我们获得的所有结果(57 份答案!),并与自愿接受采访的用户进行了用户访谈。
作为对上个月进行的用户调查的后续行动,我们发布了一篇关于 学习区调查的总结。
在我们分析了访谈数据,创建了用户洞察卡,并浏览了调查回复中推荐的所有资源后,我们对任务进行了优先排序,并开始为学习区域创建线框图。正在进行的线框图可在 Figma 上访问。
在 6 月,我们将开始收集用户对线框图的反馈,并最终开始为新的学习页面创建设计。
2. OCaml 文档
我们完成了 序列 和 错误处理 教程。 安装页面 已上线,并且对 第一天教程 进行了改进。
要求社区帮助审查新文档页面的初始版本非常成功,因此我们计划在未来几个月内为准备审查的页面打开更多讨论帖子。
我们非常感谢所有帮助审查文档的贡献者,无论是通过在讨论区分享见解,还是通过参与 GitHub 上的 PR 审查。这正是我们设想创建新的 OCaml.org 文档的努力方式,因此我们感谢所有参与并将此活动转变为社区倡议的人!
相关的 PR 和活动
- 寻求社区对新的错误处理文档页面的反馈 https://discuss.ocaml.org/t/updating-the-error-handling-tutorial/12022
- 第一天改进 ocaml/ocaml.org#1153
- 函子的代码行编辑 ocaml/ocaml.org#1127
- 重写函数式编程文档的介绍 ocaml/ocaml.org#971
- 从 V2 PR 中导入重写的集合教程 ocaml/ocaml.org#948
- 文档:序列 ocaml/ocaml.org#791
- 添加专门的“安装”页面 ocaml/ocaml.org#1038
- 编辑/测试if 语句 ocaml/ocaml.org#974
- 更新标签 ocaml/ocaml.org#1040
- 从安装说明中删除
ppa/avsm
包 ocaml/ocaml.org#1186 - 外部贡献者
- 快速入门中的错别字 ocaml/ocaml.org#1162
- 修复了几个语法错误 ocaml/ocaml.org#1188
- 更新了文本,以删除对未突出显示的突出显示代码的引用。 ocaml/ocaml.org#1213
- 修复了教程中
Sys.getenv_opt
类型签名 ocaml/ocaml.org#1228 - 更新元编程 ocaml/ocaml.org#1232
包内文档搜索
在 4 月,我们开始着手为 OCaml.org 上的 OCaml 包构建包内搜索功能。我们在 5 月继续这项工作,并在月底发布了该功能。现在 OCaml.org 上的每个包都可以进行包内搜索!:tada
请注意,这是该功能的第一个最小版本。我们计划在未来几个月内进行许多改进,尤其是因为 odoc
团队目前正在努力向 odoc
中添加搜索功能。
相关的 PR 和活动
- 修复不完整的搜索索引 ocaml-doc/voodoo#59
- 集成实验性的浏览器内搜索 ocaml/ocaml.org#1165
- 在讨论区获取社区对包内搜索最小原型的反馈 on Discuss
一般改进
我们批准并合并了许多更改,包括在缓存清除 URL 下提供 OCaml.org 的静态资源、为了更好的代码健康状况进行重构以及分别抓取 OCaml Planet 订阅源。衷心感谢所有贡献者!
我们开始着手为 OCaml.org 创建一个设计系统,重点关注按钮、下拉菜单和排版。作为这项工作的一部分,我们投入了时间研究了对 CSS 的潜在改进,包括从 Tailwind 迁移到 UnoCSS 以更好地支持自定义规则。我们向 UnoCSS 发起了一个问题,以探索独立 CLI 的选项,并开始为重复出现的 UI 元素创建 Dream 组件。
我们开始着手为博客搜索添加标签,并将旧 OCaml Planet 的多个 RSS 订阅源添加到 OCaml 博客。因此,我们不得不解决与这些新的 RSS 订阅源相关的問題。
相关的 PR 和活动
- 错误修复
- 在 changelog.eml 中关闭
form
标签 ocaml/ocaml.org#1155 - 安装页面:只区分 Windows 和其他所有系统;修复了错误的默认选择 ocaml/ocaml.org#1191
- 在 changelog.eml 中关闭
- 数据
- 提高 Ahrefs 任务的优先级,因为它仍然相关 ocaml/ocaml.org#1168
- 外部贡献者
- 对媒体使用
OCamlorg_static.Media.url
ocaml/ocaml.org#1163 - 在工业用户页面中添加 O(1) labs ocaml/ocaml.org#1180
- 对媒体使用
- OCaml Planet
- 将 Signal 和 Threads 添加为 RSS 订阅源 ocaml/ocaml.org#1197
- 修复 RSS 订阅源的文件名 ocaml/ocaml.org#1198
- 如果缺少,则创建 RSS 订阅源
planet
文件夹 ocaml/ocaml.org#1200 - 将 OCaml 每周新闻的档案添加到
/blog
ocaml/ocaml.org#1201 - 修复抓取路径管理 ocaml/ocaml.org#1204
- 添加 Caml 每周新闻 RSS 订阅源 ocaml/ocaml.org#1207
- 添加 Signal 和 Threads RSS 订阅源 ocaml/ocaml.org#1209
- 添加 emelle.tv RSS 订阅源 ocaml/ocaml.org#1217
- 添加 ocaml.org 精选 RSS 订阅源 ocaml/ocaml.org#1218
- 其他
- 从文件系统提供仪表板资产 ocaml/ocaml.org#1167