DiamondLightSource/mkdocs-techdocs-diamond

Migrate to Mkdocs 1.6.0

Open

#14 opened on May 7, 2024

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (0 forks)auto 404
buggood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the changes in Mkdocs 1.6.0 that affect plugin behavior, and determine whether to update the config loading approach or refactor to an all in code method similar to mkdocs techdocs core.
Tech stack
python
Domain
developer experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70