superfly/corrosion

Replace mdbook-admonish with native admonitions

開放

#501 建立於 2026年8月7日

在 GitHub 查看
 (1 則留言) (0 個反應) (0 位負責人)Rust (83 個分叉)auto 404
documentationgood first issuehelp wanted

倉庫指標

星標
 (1,817 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

Corrosion's documentation is built using mdbook. Currently we pinned it to mdbook@0.4.52 because we rely on mdbook-admonish which doesn't support newer versions.

We can remove the mdbook-admonish dependency entirely by using mdbook native admonitions similar to: https://github.com/max-sixty/prql/commit/eb81de099a031e6fe9cdadf2e1d25cbc79eb4764

貢獻者指南

研究方向
檢查文件現有的提示區塊，並與 mdbook 原生提示區塊語法進行比較。查看引用的 PRQL 提交以了解遷移方法。更新工作流程以移除 mdbook 版本固定和 mdbook admonish 依賴。
技術棧
rust
領域
documentationbuild system
議題類型
重構
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitmdbookMarkdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75