返回新聞

OCaml.org 電子報：2023 年 3 月

歡迎來到 OCaml.org 電子報的首刊！

我們將仿效現已退役的 Multicore 每月電子報和編譯器電子報，每月發布電子報，內容關於 OCaml.org 開發的進度。

這份電子報由 @sabine 和 @tmattio 彙編，回顧了我們 3 月在 OCaml.org 上所做的工作。

我們將重點介紹在三個不同領域所做的工作

  • 套件文件：根據使用者回饋，在過去幾個月中，我們一直專注於改進套件文件區域。這項工作在今年年初開始，團隊進行了一項調查和使用者訪談，目前已接近改進的尾聲。
  • 學習區：在改進套件文件之後，下一個里程碑是開始開發學習區，目標是改善 OCaml 新使用者的學習體驗，並為初學者和經驗豐富的開發人員提供新的文件資源。
  • 一般維護：我們也進行了一般維護和改進，並將重點介紹其中一些。

非常感謝所有透過參與調查、在 Discuss 上提供回饋以及開啟 Issue 和 Pull Request 而做出貢獻的社群成員！您的貢獻和回饋使我們能夠在使 OCaml.org 成為學習 OCaml 和發現 OCaml 套件的最佳資源方面取得進展！

套件文件

當我們開始研究套件文件導覽時，我們在 OCaml Discuss 論壇上聯絡社群，針對 OCaml.org 上的「套件」和「學習」區域進行了一項調查。這樣做的目的是為了讓我們的新團隊成員，一位 UX/UI 設計師，能夠快速上手並為 OCaml.org 做出有影響力的貢獻。感謝社群的積極參與，這證明是一種非常有效的方法，可以找出最需要解決的問題。

本月，我們完成了代表不同類型使用者的 人物誌，其中包括中階開發人員、學生、團隊領導、資深開發人員、學術講師/研究人員。

我們為套件部分的兩種可能設計方案設計了 UI 和使用者流程（其中包括套件概觀頁面、套件文件、套件搜尋結果，以及即將推出的列出套件所有版本的頁面）。您可以在 Figma 上存取設計。

我們在 Figma 中對設計的（低擬真度）實作取得了良好的進展，並且我們仍然有一些 UI 元素需要重新設計，以使網站與設計保持一致。

相關 PR/Issue

  1. 現在，我們在套件概觀佈局上顯示 README/CHANGELOG/LICENSE，而不是在文件佈局中顯示。這更好地反映了它們作為「隨附套件的檔案」的狀態。
  2. 重新設計了原始碼下載按鈕和原始碼雜湊顯示，以獲得更好的使用者體驗。
  3. 重新排列了套件概觀頁面。這改進了樣式和相依性、標籤、描述、發布日期的放置。
  4. 改進了作者/維護者顯示，以 (1) 在我們沒有給定使用者的頭像時，呈現自動產生的頭像，以及 (2) 將過多的作者/維護者隱藏在「顯示更多」按鈕後面。
  5. 為了更容易掃描相關相依性，我們將相依性分為「開發相依性」和常規相依性
  6. 在 將套件概觀側邊欄移至左側後，套件概觀頁面和套件文件頁面統一使用相同的佈局
  7. 現在，我們在套件概觀頁面上呈現目錄

學習區

我們開始了探索階段，其中我們正在清點 OCaml.org 學習區的當前內容和結構。我們回顧了第一季度關於學習和套件區域的調查中的使用者訪談影片，以提取使用者需求和痛點。我們還開始準備一項專門針對 OCaml 新使用者（包括程式設計初學者和經驗豐富的開發人員）的調查。在我們發布這份電子報時，我們已經完成了調查，我們將在這份電子報的下一期分享結果。

在未來幾個月中，改善學習區將是我們最大的重點，因此請期待在接下來的電子報中獲得更多相關更新。

一般維護

使用者介面變更

  1. README/LICENSE/CHANGELOG 的顯示現在使用套件概觀頁面佈局，而不是文件佈局。
  2. @YassineHaouzane 在練習區的問題中新增了練習難度的顯示。非常感謝您！
  3. 頂部導覽列中的套件搜尋下拉式選單現在允許您使用鍵盤導覽搜尋結果。
  4. 當在套件文件頁面上使用版本切換器下拉式選單時，現在會保留文件中的當前路徑。
  5. （進行中）我們在 新增一個頁面到社群區，重點介紹 Outreachy 實習專案方面取得了進展。
  6. （進行中）我們在 在套件概觀頁面上公開 check.ocamllabs.io 建置資訊方面取得了進展。
  7. （進行中）我們開始與社群合作，新增一個專用的「安裝」頁面：Discuss 討論串 請改進我在 OCaml.org 上「安裝」頁面的草稿。

更新 OCaml.org 的資料

  1. 在 OCaml Discuss 論壇上宣布職位區之後，團隊審閱並合併了外部貢獻者提交的職位列表。謝謝大家！
  2. 已新增 Outreachy 專案的影片，但尚未透過專用頁面公開。

內部維護、程式碼健康狀況和錯誤修正

  1. 為了方便人們為 OCaml.org 做出貢獻，「ood」（OCaml.org 的資料庫和資料剖析器）的程式碼進行了一些重構。
  2. 所有指向 ocaml.org（子網域）的內部連結都已變更為使用 https，以避免不必要的重新導向。
  3. 在 odoc 升級後，OCaml.org 無法正確選取 README/LICENSE/CHANGELOG 檔案。現在可以了。
  4. @voodoos 修復了 OCaml 遊樂場中無法運作的 Merlin。
  5. 當部署新版本時，套件資訊過去會在大約一分鐘內無法使用。現在，問題：當套件資訊重新產生時，套件資訊無法使用已修復。
  6. 錯誤修正：不要在所有版本都避免使用版本的套件上崩潰。
  7. 套件階層連結範本現在使用來自 odoc 的階層連結資料。
  8. 為處理常式函式引入了短路 404 let 繫結運算子：PR：在找不到時傳回 404。
  9. 我們一直有虛假的 CI 建置失敗，因為 CI 會使用最新版本的 opam-repository。現在，我們將 opam-repository 固定在所有三個位置：1) Makefile、2) Dockerfile、3) GitHub actions。
  10. 版本升級：ocaml 至 4.14.1、GitHub Actions 中的 actions/checkout@v3、dune 至 3.6。
  11. 在 #628 中新增視覺上強調目標標題後，有兩組懸停樣式應用於套件文件標題中的錨點目標。此問題已解決：PR：移除重複的 doc.css 錨點目標樣式，調整懸停樣式。
  12. 當您從「學習」頁面導覽到教學時，出現右側邊欄無法顯示的問題。感謝 #1021 和 #1041，側邊欄現在可以透過 HTMX 提供的 AJAX 導覽正常運作。
  13. 一位使用者回報了字體大小/佈局的問題。我們將 Tailwind 基於 px 的中斷點變更為基於 em 的中斷點，以尊重人們的瀏覽器和作業系統字體大小設定。
  14. （進行中）新增 sitemap.xml 以協助搜尋引擎索引 OCaml.org 所有頁面的工作正在進行中。