superfly/corrosion

Replace mdbook-admonish with native admonitions

Ouverte

#501 ouverte le 7 août 2026

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Rust (83 forks)auto 404
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (1 817 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Inspectez les admonitions existantes dans la documentation et comparez les avec la syntaxe native des admonitions de mdbook. Consultez le commit PRQL de référence pour l'approche de migration. Mettez à jour le workflow pour supprimer l'épinglage de version de mdbook et la dépendance à mdbook admonish.
Stack technique
rust
Domaine
documentationbuild system
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitmdbookMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75