superfly/corrosion

Replace mdbook-admonish with native admonitions

Open

#501 opened on Aug 7, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (83 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (1,817 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Inspect existing admonitions in the documentation and compare with mdbook's native admonition syntax. Review the referenced PRQL commit for migration approach. Update the workflow to remove the mdbook version pin and the mdbook admonish dependency.
Tech stack
rust
Domain
documentationbuild system
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitmdbookMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75