superfly/corrosion

Replace mdbook-admonish with native admonitions

Offen

#501 geöffnet am 07.08.2026

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Rust (83 Forks)auto 404
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (1.817 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche die vorhandenen Admonitions in der Dokumentation und vergleiche sie mit der nativen Admonitions Syntax von mdbook. Überprüfe den referenzierten PRQL Commit für den Migrationsansatz. Aktualisiere den Workflow, um die Versionssperre von mdbook und die Abhängigkeit von mdbook admonish zu entfernen.
Tech Stack
rust
Domain
documentationbuild system
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitmdbookMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75