OCaml.org 新闻通讯:2023 年 11 月 + 12 月
欢迎来到 2023 年 11 月和 12 月版的 OCaml.org 新闻通讯!此更新由 OCaml.org 团队编制。您可以在 Discuss 上找到 以前的更新。
我们的目标是使 OCaml.org 成为任何想要开始并高效使用 OCaml 的最佳资源。OCaml.org 新闻通讯提供了我们朝着该目标取得的进展的更新以及我们正在进行的更改概述。
没有所有帮助我们审查、修改和创建更好 OCaml 文档的出色 OCaml 社区成员,我们无法做到这一点。您的反馈使我们能够更好地优先考虑我们的工作并朝着我们的目标取得进展。谢谢!
本新闻通讯涵盖
- 学习区:我们对学习区的 UI 进行了重大更改,引入了新的着陆页并改进了学习区子页面的各个元素。文档搜索功能正在开发中,并且已添加或大幅改进新文档!
- 即将推出的深色模式:我们完成了即将推出的深色模式的 UI 设计,我们的 Outreachy 实习生已开始实施更改。
- 宣布 Outreachy 实习生:我们很高兴欢迎两名实习生参与 OCaml 项目!
- 一般改进:与往常一样,我们还根据用户反馈对一般维护和改进进行了处理,因此我们在下面重点介绍了一些工作。
面向贡献者的开放问题
我们为外部贡献者创建了许多问题。其中大多数适合 OCaml 初学者,我们很乐意审查您的拉取请求并提供反馈!
您可以在 此处找到面向贡献者的开放问题!
学习区
1. 学习区重新设计
OCaml.org 正在经历激动人心的转型,我们很高兴与您分享一些关键更新。我们的主要重点是新的用户界面 (UI) 设计的最终确定和批准,旨在增强您的体验。此更新不仅仅是外观;我们确保网站已针对移动设备和平板电脑设备完全优化。
我们团队与您这样的用户之间的合作在塑造项目中发挥了重要作用。您的投入和支持非常宝贵,我们感谢社区参与使该网站尽善尽美。
我们的设计系统已经过多次更新,包括新的组件,例如可变的着陆页按钮,不同的图标(包括社交媒体和 OCaml 图标,如 Dune 和 opam),增强的文本样式,更新的颜色变量等等。
我们已完成学习区域所有页面的设计。每个页面都经过精心设计,确保所有版本之间的一致性和连贯性。
如果您好奇并想更仔细地查看设计,您可以访问我们的 Figma 设计文件。请注意,页面上显示的内容并不总是准确的。我们的目标是为我们的设计师提供更好的内容,以供将来进行模型制作和 UI 设计。
12 月份完成了学习区域浅色模式新设计的实施工作!
相关 PR 和活动
- 根据 Figma 实现学习 UI ocaml/ocaml.org#1798
- @FatumaA 贡献:改进平台页面卡片样式 ocaml/ocaml.org#1752
- @florentdrousset 贡献:将练习链接到教程 ocaml/ocaml.org#1753
- 根据 Figma 设计添加书籍链接 - ocaml/ocaml.org#1834
- WIP:文档搜索功能 - ocaml/ocaml.org#1871
2. OCaml 文档
11 月份,我们专注于解决和整合社区对“入门”文档的反馈。Discuss 上的评论和讨论非常有帮助。我们鼓励更多这样的讨论!
我们还致力于完善“基本数据类型”和“值与函数”。此外,团队一直在编写新的“模块”、“函子”和“使用 Dune 的库”文档,希望在年底之前完成这些文档以及社区审核中的文档(如下)。
相关 PR 和活动
- 进行中
- 集合
- 映射
- 高阶函数
- 内部审核中
- 社区审核中
- 模块、函子、使用 Dune 的库(参见 Discuss)
- 文件操作(参见 Discuss 线程)
- 多态变体(参见 Discuss 线程)
- 已发布
- 在 opam 切换中运行命令
- 可变状态 / 命令式编程(参见 Discuss 线程)
- Discuss 上的公告:关于 OCaml 基础知识的新教程
- 基本数据类型(参见 Discuss 线程)
- 函数和值(参见 Discuss 线程)
- 安装 OCaml(参见 Discuss 线程)
- OCaml 巡回指南(参见 Discuss 线程)
- 您的第一个 OCaml 程序(参见 Discuss 线程)
- opam 切换介绍
- 修复 Apple M1 上的 Homebrew 错误
- 运算符
- 错误处理(参见 Discuss 线程)
- 数组(参见 Discuss 线程)
- 序列(参见 Discuss 线程)
- 其他活动:
- 我们将 OCaml 图书中的页面集成到学习区域,经许可在 OCaml.org 上复制 - ocaml/ocaml.org#1766
- 来自 Real World OCaml 的编译器和运行时页面,以及
- 来自 OCaml Programming: Correct + Efficient + Beautiful 的备忘录化和单子
- 重新排列语言文档选项卡上的部分 - ocaml/ocaml.org#1756
- 文档格式:用突出显示替换无意义的块引用 ocaml/ocaml.org#1759
- 我们改进了“OCaml 是 Web 语言吗?”页面,添加了许多新包,并修改了文本以更准确地反映 OCaml Web 生态系统的当前状态 - ocaml/ocaml.org#1843
- 编辑基本数据类型 - ocaml/ocaml.org#1827
- 值和函数 :: 解决问题 #1762 中提出的建议 - ocaml/ocaml.org#1812
- 我们将 OCaml 图书中的页面集成到学习区域,经许可在 OCaml.org 上复制 - ocaml/ocaml.org#1766
- 贡献
- @benjamin-thomas 通过提供一个使用不同类型作为键和值的更好示例来改进
Map
文档 ocaml/ocaml.org#1743 - @leostera 简化了“使用 Dune 引导项目”指南 - ocaml/ocaml.org#1792
- @FatumaA 修复了“OCaml 巡回指南”中的一个拼写错误 ocaml/ocaml.org#1739
- @binwang-dev 贡献:修复教程中的类型不一致 ocaml/ocaml.org#1757
- @J3RN 贡献:修复“您的第一个 OCaml 程序”中的转义问题 - ocaml/ocaml.org#1846
- @Sc4ramouche 贡献:将 std 容器指南的比较添加到 v3 文档 - ocaml/ocaml.org#1828
- @Sc4ramouche 贡献:修复 OCaml 巡回指南中的拼写错误 - ocaml/ocaml.org#1820
- @J3RN 贡献:修复损坏的“安装平台工具”链接 - ocaml/ocaml.org#1841
- @benjamin-thomas 通过提供一个使用不同类型作为键和值的更好示例来改进
我们开始打开标记为“需要帮助”的问题,以使外部贡献者能够帮助改进文档。反应非常积极,我们很高兴继续这样做,并借助您的帮助,使 OCaml 文档真正出色!
即将推出的深色模式
12 月份,oyenuga17 开始在 OCaml.org 上实施新的深色模式。计划是根据浏览器/操作系统首选项在 3 月初完成并激活深色模式。
我们不断将小补丁合并到 ocaml.org,您可以在 https://staging.ocaml.org 上查看已完成的深色模式页面。我们在页面底部放置了一个按钮,用于在暂存环境中切换深色模式(这不会发布,它只是我们审查深色模式页面的方法)。
相关活动和 PR
- 在学习区域着陆页上实现深色模式 - ocaml/ocaml.org#1836
- 所有 OCaml.org 页面深色模式的 UI 设计,以及由此产生的设计系统更改
宣布 Outreachy 实习生
11 月,我们审核并评估了深色模式项目和 GUI 项目的 Outreachy 贡献,并选出了两名实习生。@oyenuga17 将与 OCaml.org 团队合作实现深色模式,而 @IdaraNabuk 被选中负责 GUI 项目。祝贺 @IdaraNabuk 和 @oyenuga17!
由于 Outreachy 申请期已于 10 月结束,我们在下面的“通用改进”部分列出了所有在 Outreachy Issues 上完成的剩余拉取请求。
通用改进
最重要的更改 TLDR:
- 现在 OCaml.org 有一个自托管的 Plausible.io 实例,可通过 https://plausible.ci.dev/ocaml.org 访问!
- 您可以在新的治理页面 https://ocaml.org.cn/governance 上查看不同的 OCaml 团队(编译器、平台、打包、基础设施、OCaml.org)以及相关存储库的维护者!
- OCaml 徽标现在在 https://ocaml.org.cn/logo 上有一个专门的页面!
- 我们现在在软件包概述页面上显示软件包的 README。
- 您现在可以在 https://ocaml.org.cn/community 上 列出即将举行的活动,包括日期和时间。
- OCaml.org 现在有社交媒体图片,这样分享 OCaml.org 链接看起来更漂亮。
衷心感谢 11 月和 12 月帮助改进 OCaml.org 的众多贡献者。请在下面找到他们的名单!
相关 PR 和活动
- 功能/改进
- 添加了一个治理页面,列出了编译器、OCaml 平台的所有项目和 ocaml.org 基础设施的维护者和开发会议 - ocaml/ocaml.org#1239
- @IdaraNabuk 贡献:为社区页面添加了记录即将发生的事件的功能 - ocaml/ocaml.org#1717
- @Girish-Jangam 贡献:为 OCaml 徽标添加了一个页面 - ocaml/ocaml.org#1711
- 添加禁用 OCaml Planet 源/修复刮取器并刮取缺失的 Planet 帖子的功能 - ocaml/ocaml.org#1734
- @leostera 贡献:软件包搜索 UX 改进 - ocaml/ocaml.org#1691
- 添加了一个 OpenSearch 清单,这样您就可以将 OCaml 软件包搜索添加到您的浏览器搜索栏中
- 使主导航栏中的搜索输入更早获得 tab 焦点
- 将 tabindex="1" 设置为软件包文档页面上的软件包内搜索输入
- 在软件包搜索结果页面上自动聚焦搜索输入
- @mays4 贡献:为所有可以贡献的数据项添加指向 CONTRIBUTING.md 的链接 - ocaml/ocaml.org#1682
- @m-spitfire 贡献:更改日志页面上的条目现在已分页 - ocaml/ocaml.org#1751
- 向 OCaml.org HTML 元数据添加缺失的社交媒体图片。现在,在社交媒体上分享的帖子使用 OCaml 徽标作为图片,这比没有图片要好得多 - ocaml/ocaml.org#1784
- 我们现在在软件包概述页面上显示软件包的 README。这是今年早些时候软件包区域重新设计中设计选项之一的一部分。但是,并不完全清楚这样做是否正确。更多确认来自人们要求此功能,因此我们这样做了。- ocaml/ocaml.org#1832
- 更新到 Tailwind CSS 3.3.6 - ocaml/ocaml.org#1850
- 在“OCaml 是不是 Web 了”中添加了目录,以便跳转到各个部分 - ocaml/ocaml.org#1849
- @RWUBAKWANAYO 贡献:改进了发布页面上的响应式布局 - ocaml/ocaml.org#1716
- @kiyov09 贡献:减少了博客页面中的新闻项目数量,以使高度与 OCaml Planet 列相似 - ocaml/ocaml.org#1754
- @oyenuga17 贡献:改进了论文页面上表格的响应式折叠 - ocaml/ocaml.org#1741
- 错误修复
- 调整主导航元素的 CSS 顺序,从 0 开始 - ocaml/ocaml.org#1745
- 在学习选项卡选择元素上设置正确的背景颜色 - ocaml/ocaml.org#1746
- @Solar-Rays 贡献:从 Outreachy 项目描述中删除链接以防止溢出 - ocaml/ocaml.org#1764
- 修补上游依赖项
river
以在links
标签不存在时回退到供稿条目的id
。这允许成功刮取更多供稿。- tarides/river#11 - 添加缺失的行为准则路由 - ocaml/ocaml.org#1781
- 添加脚注中缺失的“平台工具”链接 - ocaml/ocaml.org#1788
- @AndroGenius-codes 贡献:修复了分页中的一个错误,其中页面号“1”在所有结果都适合单个页面时显示了两次 - ocaml/ocaml.org#1729
- @Demmythetechie 贡献:将
word-wrap: break-word
添加到 Tailwind Typography 散文类,以防止内容区域中的长 URL 溢出 - ocaml/ocaml.org#1722 - @AndroGenius-codes 贡献:缩短社区页面上 Outreachy 项目链接上的文本以防止溢出 - ocaml/ocaml.org#1749
- @oyenuga17 贡献:在论文页面和发布页面上将搜索查询呈现为输入值 - ocaml/ocaml.org#1747
- @FatumaA 贡献:在主页上“查看所有发布”按钮下方添加间距 - ocaml/ocaml.org#1740
- @RWUBAKWANAYO 贡献:解决发布列表标题中的文本样式问题 ocaml/ocaml.org#1773
- @kevanantha 贡献:修复练习的无效链接 ocaml/ocaml.org#1802
- 其他
- @oyenuga17 贡献:用
cmarkit
替换依赖项omd
- ocaml/ocaml.org#1642。感谢您提供这个出色且具有挑战性的贡献! - 删除 Yoshi 工具 - ocaml/ocaml.org#1735
- 删除 dream-dashboard,它被一个自托管的 plausible.io 实例取代 - ocaml/ocaml.org#1736
- 将教程->文档重命名为学习区域的元标题 - ocaml/ocaml.org#1789
- @oyenuga17 贡献:用
- 内容
- 在书籍部分添加了“使用 OCaml 的函数式编程和编程语言结构入门” - ocaml/ocaml.org#1744
- 添加了 opam.2.2.0~alpha3 的更改日志 - ocaml/ocaml.org#1771
- 将平台路线图文档的标题更新为“OCaml 平台路线图” - ocaml/ocaml.org#1790
- 向 OCaml Planet 添加了一些供稿 - ocaml/ocaml.org#1779
- 在 Planet 中添加了“实用 OCaml”博客 - ocaml/ocaml.org#1806
- @caisar-platform 贡献:修复了 CEA 研究工程师职位发布中的损坏链接。 ocaml/ocaml.org#1787
- @KihongHeo 贡献:将 KAIST 添加为学术机构 ocaml/ocaml.org#1791
- @hetzenmat 贡献:修复 5.1.1 的错误发布日期 - ocaml/ocaml.org#1858
- @zapashcanon 贡献:修复演示文稿的顺序 - ocaml/ocaml.org#1859
- @oyenuga17 贡献:添加 Outreachy 博客 | 自我介绍 - ocaml/ocaml.org#1848
- @IdaraNabuk 贡献:将 Outreachy 博客文章添加到 OCaml Planet ocaml/ocaml.org#1878
- 添加了“将并行性改造到 OCaml 上”论文 - ocaml/ocaml.org#1875