DiamondLightSource/mkdocs-techdocs-diamond

Migrate to Mkdocs 1.6.0

Open

#14 创建于 2024年5月7日

在 GitHub 查看
 (0 评论) (0 反应) (1 负责人)Python (0 fork)auto 404
buggood first issue

仓库指标

Star
 (1 star)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南

研究方向
检查Mkdocs 1.6.0中影响插件行为的变化，并决定是更新配置加载方法还是重构为类似mkdocs techdocs core的全代码方法。
技术栈
python
领域
developer experience
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Python
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70