OCaml.org 電子報:2023 年 11 月 + 12 月
歡迎來到 OCaml.org 電子報 2023 年 11 月和 12 月的內容!此更新由 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 月,已完成學習區淺色模式的新設計實作工作!
相關的提取請求和活動
- 從 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 的程式庫」文件,希望能在年底前發布這些文件以及社群審查中的文件(如下所示)。
相關的提取請求和活動
- 進行中
- 集合
- 對應
- 高階函式
- 審查中(內部)
- 審查中(社群)
- 模組、函式器、使用 Dune 的程式庫(請參閱Discuss)
- 檔案操作(請參閱Discuss 線程)
- 多型變體(請參閱Discuss 線程)
- 已發布
- 在 opam Switch 中執行命令
- 可變狀態/命令式程式設計(請參閱Discuss 線程)
- 在 Discuss 上公告:關於 OCaml 基礎的新教學
- 基本資料類型(請參閱Discuss 線程)
- 函式和值(請參閱Discuss 線程)
- 安裝 OCaml(請參閱Discuss 線程)
- OCaml 導覽(請參閱Discuss 線程)
- 您的第一個 OCaml 程式(請參閱Discuss 線程)
- opam Switch 簡介
- 修正 Apple M1 上的 Homebrew 錯誤
- 運算子
- 錯誤處理(請參閱Discuss 線程)
- 陣列(請參閱Discuss 線程)
- 序列(請參閱Discuss 線程)
- 其他活動:
- 我們將 OCaml 書籍中的頁面整合到學習區中,並經許可在 OCaml.org 上重新發布 - ocaml/ocaml.org#1766
- 來自 Real World OCaml 的編譯器和執行階段頁面,以及
- 來自 OCaml 程式設計:正確 + 高效 + 優美 的記憶化和 Monad
- 重新排列了語言文件索引標籤上的章節 - 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 貢獻:將標準容器指南的比較新增至 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 上查看已完成的黑暗模式頁面。我們在頁面底部放置了一個按鈕,以切換測試環境上的黑暗模式(這不會發布,這只是我們審查黑暗模式頁面的一種方式)。
相關活動和提取請求
- 在學習區登陸頁面上實作黑暗模式 - ocaml/ocaml.org#1836
- 所有 OCaml.org 頁面的黑暗模式 UI 設計,以及由此產生的設計系統變更
宣布 Outreachy 實習生
11 月,我們審查並評分了黑暗模式專案和 GUI 專案的 Outreachy 貢獻,並選出了兩位實習生。@oyenuga17 正在與 OCaml.org 團隊合作實作黑暗模式,而 @IdaraNabuk 則入選了 GUI 專案。恭喜 @IdaraNabuk 和 @oyenuga17!
由於 Outreachy 申請期於 10 月結束,我們將所有在「一般改進」章節中 Outreachy 議題上完成的剩餘提取請求列出。
一般改進
最重要變更的 TLDR:
- 現在有一個適用於 OCaml.org 的自我託管 Plausible.io 執行個體,可透過 https://plausible.ci.dev/ocaml.org 存取!
- 您可以在新的治理頁面 https://ocaml.dev.org.tw/governance 上查看不同的 OCaml 團隊(編譯器、平台、封裝、基礎架構、OCaml.org)和相關存放庫的維護者!
- OCaml 標誌現在有了專屬頁面,網址是 https://ocaml.dev.org.tw/logo!
- 我們現在會在套件總覽頁面顯示套件的 README。
- 您現在可以在 https://ocaml.dev.org.tw/community 上列出即將舉辦的活動,包含日期和時間。
- OCaml.org 現在有了社群媒體圖片,讓分享 OCaml.org 連結時看起來更美觀。
非常感謝眾多貢獻者在 11 月和 12 月協助改進 OCaml.org。以下列出他們的貢獻!
相關的提取請求和活動
- 功能 / 改進
- 新增了一個治理頁面,列出編譯器的維護者和開發會議、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 貢獻:改進套件搜尋的使用者體驗 - 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
- 在學習頁籤的 select 元素設定正確的背景顏色 - ocaml/ocaml.org#1746
- @Solar-Rays 貢獻:從 Outreachy 專案描述中移除連結,以防止溢出 - ocaml/ocaml.org#1764
- 修補上游依賴項
river
,使其在links
標籤不存在時,回退到使用 feed 項目的id
。這讓更多 feed 可以成功抓取。- tarides/river#11 - 新增遺失的行為準則路由 - ocaml/ocaml.org#1781
- 在頁尾新增遺失的「平台工具」連結 - ocaml/ocaml.org#1788
- @AndroGenius-codes 貢獻:修正分頁中的一個錯誤,當所有結果都可以顯示在單一頁面時,頁碼「1」會顯示兩次 - ocaml/ocaml.org#1729
- @Demmythetechie 貢獻:在 Tailwind Typography prose class 中新增
word-wrap: break-word
,以防止內容區域中的長網址溢出 - 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 貢獻:將依賴項
omd
替換為cmarkit
- ocaml/ocaml.org#1642。感謝這個優秀且具有挑戰性的貢獻! - 移除 Yoshi 工具 - ocaml/ocaml.org#1735
- 移除 dream-dashboard,它已由自託管的 plausible.io 實例取代 - ocaml/ocaml.org#1736
- 在學習區域的 meta 標題中,將 Tutorials->Documentation 更名 - 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 中新增一些 feed - ocaml/ocaml.org#1779
- 將「Practical OCaml」部落格新增至 Planet - 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