DiamondLightSource/mkdocs-techdocs-diamond

Migrate to Mkdocs 1.6.0

Open

#14 ouverte le 7 mai 2024

Voir sur GitHub
 (0 commentaires) (0 réactions) (1 assigné)Python (0 forks)auto 404
buggood first issue

Métriques du dépôt

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

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

Guide contributeur

Direction de recherche
Examinez les modifications apportées à Mkdocs 1.6.0 qui affectent le comportement du plugin et décidez s'il faut mettre à jour l'approche de chargement de la configuration ou refactoriser vers une approche tout en code similaire à mkdocs techdocs core.
Stack technique
python
Domaine
developer experience
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70