superfly/corrosion

Replace mdbook-admonish with native admonitions

Aberta

#501 aberto em 7 de ago. de 2026

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Rust (83 forks)auto 404
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (1.817 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Inspecione as admonitions existentes na documentação e compare com a sintaxe nativa de admonitions do mdbook. Revise o commit PRQL referenciado para a abordagem de migração. Atualize o workflow para remover a fixação da versão do mdbook e a dependência do mdbook admonish.
Pilha de tecnologia
rust
Domain
documentationbuild system
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitmdbookMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75