OCaml.org 電子報:2024 年 1 月號
歡迎來到 OCaml.org 電子報 2024 年 1 月號!本次更新由 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 和活動
- 進行中
- Maps
- 高階函數
- 審閱中(內部)
- 審閱中(社群)
- 檔案操作(請參閱Discuss 討論串)
- 多型變體(請參閱Discuss 討論串)
- 已發布
- 集合
- 選項
- 使用 Dune 的模組、函子、函式庫(請參閱Discuss)
- 標記參數
- OCaml Playground,由 @The-Amoghavarsha 提供
- 在 opam 交換器中執行命令
- 可變狀態 / 命令式程式設計(請參閱Discuss 討論串)
- 在 Discuss 上發布的公告:OCaml 基礎知識的新教學
- 基本資料類型(請參閱Discuss 討論串)
- 函數和值(請參閱Discuss 討論串)
- 安裝 OCaml(請參閱Discuss 討論串)
- OCaml 導覽(請參閱Discuss 討論串)
- 您的第一個 OCaml 程式(請參閱Discuss 討論串)
- opam 交換器簡介
- 修正 Apple M1 上的 Homebrew 錯誤
- 運算符
- 錯誤處理(請參閱Discuss 討論串)
- 陣列(請參閱Discuss 討論串)
- 序列(請參閱Discuss 討論串)
- 其他活動:
- 修正值和函數教學中的程式碼範例,由 @cuihtlauac 提供
- 改進「使用 opam 管理相依性」,由 @sabine 提供
- (doc)在「發布套件」中提及
dune-release
opam 套件,由 @sabine 提供 - 將如何使用 Dune 產生
odoc
.mld
文件頁面新增至「使用odoc
產生文件」,由 @sabine 提供 - 在所有
dune
命令中前置opam exec --
,由 @sabine 提供 - 提及記錄更新語法,由 @srj31 提供
- 修正開始使用文件,由 @akindofyoga 提供
- 修正開始使用頁面上的措辭,由 @akindofyoga 提供
- 修正您的第一個 OCaml 程式教學中的錯字,由 @cuihtlauac 提供
- (doc)修正開始使用頁面上的一個小錯字,由 @akindofyoga 提供
- 移除文件中 V2 的連結,由 @cuihtlauac 提供
- (doc)一些其他小的文件問題,由 @heathhenley 提供
- 集合 V2 教學的程式碼測試,由 @christinerose 提供
- (doc)移除函式程式設計文件,由 @sabine 提供
- (doc)移除展開選項區段,由 @cuihtlauac 提供
- (doc)標記參數的小行編輯,由 @christinerose 提供
- 議題 正確使用「參數」和「引數」 已由 @PoorlyDefinedBehaviour 的多個 PR 解決
- 修正「其他安裝方法」摺疊式中的連結,由 @norskeld 提供
- (doc)更新「運算符」,在語言手冊中新增運算符表格的連結,由 @cuihtlauac 提供
- 在您的第一個 OCaml 程式中使用與函式庫名稱不同的檔案名稱,由 @cuihtlauac 提供
- 在 OCaml 導覽中提及標記參數,由 @PoorlyDefinedBehaviour 提供
- 在值和函數中提及標記參數,由 @PoorlyDefinedBehaviour 提供
- (doc)新增有關多個檔案的更多資訊,由 @heathhenley 提供
- 包含有關 if-then-else 和 begin-end 的文字,由 @cuihtlauac 提供
- 修正程式設計指南中的錯字,由 @presenthee 提供
- 修正 #1979 隱私權政策頁面上的連結 404,由 @The-Amoghavarsha 提供
- 修正選用參數教學中的錯字,由 @julbinb 提供
- (錯字)在套件頁面上新增遺失的空格,由 @sabine 提供
- 改進有關編輯器支援的文件,由 @PizieDust 提供
我們開始開啟標記為「help wanted」的議題,讓外部貢獻者能夠協助改進文件。反應非常正面,我們很高興繼續這樣做,並在您的幫助下讓 OCaml 文件真正出色!
即將推出的深色模式
在 12 月,oyenuga17 開始在 OCaml.org 上實作新的深色模式。計畫在 3 月初完成並根據瀏覽器/作業系統偏好啟用深色模式。看來我們正按計畫進行。
我們不斷將小型修補程式合併到 OCaml.org 中,您可以在 https://staging.ocaml.org 上查看已完成的深色模式頁面。我們在頁面底部放置了一個按鈕,以切換暫存上的深色模式。(這不會發布。這僅是我們審閱深色模式頁面的方式。)
已完成的頁面
- 學習/開始使用 + 語言 + 指南,由 @oyenuga17 提供
- 學習/練習,由 @oyenuga17 提供
- 學習/書籍,由 @oyenuga17 提供
- 學習/平台工具,由 @oyenuga17 提供
- 套件搜尋結果,由 @oyenuga17 提供
- 套件 + 社群,由 @oyenuga17 提供
- 部落格 + 職缺 + 變更日誌,由 @oyenuga17 提供
- 學習/概觀,由 @oyenuga17 提供
一般改進
最值得注意的變更 TLDR:
- 我們合併了一個基本的文件搜尋功能,以便在 OCaml 文件中進行搜尋。它在「學習」區域「概觀」頁面上提供!這裡有改進的空間,其中最值得注意的是新增錯字更正,以及統一頂部導覽列搜尋框中的套件和文件搜尋。
- 已修正套件文件模組樹狀檢視中顯示錯誤函式庫名稱的長期錯誤!
- 套件概觀頁面現在連結到一個新頁面,其中列出所有套件版本及其發布日期。
- 現在可以從主要登陸頁面存取變更日誌。
- 我們現在會在教學 Markdown 頁面的 YAML 元資料中連結教學的先決條件和建議的下一個教學。這可確保教學之間的這些連結保持有效。
非常感謝許多在 1 月份協助改進 OCaml.org 的貢獻者。在下方列出他們的名字!
相關的 PR 和活動
- 一般
- 文件搜尋功能,由 @SaySayo 和 @sabine 貢獻
- (功能) 新增 recommended_next_tutorials 功能,由 @enoonan 貢獻
- 為「推薦的後續教學」新增預編譯檢查,由 @enoonan 貢獻
- (功能) 新增 prerequisite_tutorials 功能,由 @PoorlyDefinedBehaviour 貢獻
- 新增套件版本頁面,由 @sabine 貢獻
- 讓變更日誌可從首頁連結,由 @FatumaA 貢獻
- 修復 #1989 職缺頁面上未對齊的下拉選單,由 @The-Amoghavarsha 貢獻
- 在練習側邊欄實作啟用狀態,由 @oyenuga17 貢獻
- 更新
Utils.human_date
以使用較新的 Timedesc API,由 @darrenldl 貢獻 - 修復語言手冊橫幅 HTML,由 @sabine 貢獻
- 如果
docs-data.ocaml.org
無法連線,則更優雅地處理錯誤,由 @sabine 貢獻 - (錯誤) 修復如果變更日誌長度 < 100 時 String.sub 拋出例外,由 @sabine 貢獻
- Gitignore *:OECustomProperty,由 @sabine 貢獻
- 從首頁移除「The OCaml System」,由 @cuihtlauac 貢獻
- 簡化推薦的後續教學的類型定義,由 @cuihtlauac 貢獻
- 套件文件
- 資料解析 (
ood-gen
) - 資料
- 新增兩篇個別的部落格文章,由 @IdaraNabuk 貢獻
- Dune 3.13.0 的變更日誌,由 @emillon 貢獻
- 變更日誌:opam.2.2.0~beta1,由 @kit-ty-kate 貢獻
- 新增拉瓦爾大學作為 OCaml 的學術用戶,由 @bktari 貢獻
- 新增 2 個 XenServer 職缺,由 @edwintorok 貢獻
- (資料) 新增
priver.dev
OCaml Feed,由 @emilpriver 貢獻 - 新增 Dune 3.12.2 的變更日誌,由 @emillon 貢獻
- 列表使用 Yaml 破折號,由 @cuihtlauac 貢獻
- 新增遺失的平台變更日誌,由 @tmattio 貢獻
- 儲存庫文件