OCaml.org 電子報:2023 年 5 月
歡迎來到 OCaml.org 電子報 2023 年 5 月版!如同之前的更新,本期由 @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 文件
我們完成了序列和錯誤處理教學。 安裝頁面已上線,並且對第一個小時教學進行了改進。
要求社群協助審閱新文件頁面的初始版本非常成功,因此我們計劃在未來幾個月為準備好審閱的頁面開啟更多 Discuss 貼文。
我們非常感謝所有協助審閱文件的貢獻者,無論是透過在 Discuss 上分享見解,還是參與 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 匯入重寫的 Set 教學 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
- 針對套件內搜尋的最小原型徵求社群回饋 在 Discuss 上
一般改進
我們核准並合併了許多變更,包括在快取失效 URL 下提供 OCaml.org 的靜態資產、為了更好的程式碼健康狀況進行重構,以及個別抓取 OCaml 星球訂閱源。非常感謝貢獻者!
我們開始著手建立 OCaml.org 的設計系統,重點是按鈕、下拉式選單和排版。作為這項工作的一部分,我們投入時間研究 CSS 的潛在改進,包括從 Tailwind 遷移到 UnoCSS 以獲得更好的自訂規則支援。我們開啟了一個與 UnoCSS 的問題,以探索獨立 CLI 的選項,並開始為重複出現的 UI 元素建立 Dream 元件。
我們開始著手新增標籤以方便部落格搜尋,並將舊 OCaml 星球的幾個 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) 實驗室 ocaml/ocaml.org#1180
- 將
- OCaml 星球
- 將 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