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