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