DiamondLightSource/mkdocs-techdocs-diamond

Migrate to Mkdocs 1.6.0

Open

#14 aberto em 7 de mai. de 2024

Ver no GitHub
 (0 comments) (0 reactions) (1 assignee)Python (0 forks)auto 404
buggood first issue

Métricas do repositório

Stars
 (1 star)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Changes made to mkdocs between 1.5.x and 1.6.0 have broken the behaviour of this plugin. It would be nice to maintain the config loading currently present but it may be easier to adopt the all-in-code approach taken by mkdocs-techdocs-core.

Version pinned in 9f948d4 as a temporary workaround

Guia do colaborador

Direção de pesquisa
Revise as mudanças no Mkdocs 1.6.0 que afetam o comportamento do plugin e decida se atualizar a abordagem de carregamento de configuração ou refatorar para uma abordagem totalmente em código semelhante ao mkdocs techdocs core.
Pilha de tecnologia
python
Domain
developer experience
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70