superfly/corrosion

Replace mdbook-admonish with native admonitions

オープン

#501 opened on 2026/08/07

GitHub で見る
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Rust (83 件のフォーク)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (1,817 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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
Issue 種別
リファクタリング
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitmdbookMarkdown
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75