DiamondLightSource/mkdocs-techdocs-diamond

Migrate to Mkdocs 1.6.0

Open

#14 geöffnet am 7. Mai 2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (0 Forks)auto 404
buggood first issue

Repository-Metriken

Stars
 (1 Star)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die Änderungen in Mkdocs 1.6.0, die das Plugin Verhalten beeinflussen, und entscheiden Sie, ob Sie den Konfigurationsladeansatz aktualisieren oder zu einem reinen Code Ansatz ähnlich wie mkdocs techdocs core umgestalten möchten.
Tech Stack
python
Domain
developer experience
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70