superfly/corrosion

Replace mdbook-admonish with native admonitions

Aperta

#501 aperta il 7 ago 2026

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Rust (83 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

Star
 (1817 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Ispeziona le ammonizioni esistenti nella documentazione e confrontale con la sintassi nativa delle ammonizioni di mdbook. Rivedi il commit PRQL di riferimento per l'approccio di migrazione. Aggiorna il workflow per rimuovere il pin della versione di mdbook e la dipendenza da mdbook admonish.
Tech stack
rust
Dominio
documentationbuild system
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitmdbookMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75