Add automated broken link inspector

仓库指标

星标

10,303 个星标 (10,303 个星标)

PR 合并指标

平均合并 2天 17小时 (平均合并 2天 17小时)30 天内合并 82 个 PR (30 天内合并 82 个 PR)

描述

贡献者指南

研究方向

首先，检查提供的链接中现有的 GitHub Actions 工作流，以了解当前的 CI 设置。然后，添加一个步骤来运行 mkdocs build 并将警告视为错误，或使用 mkdocs linkcheck 来检查链接。此外，通过审查 mkdocs 配置和文档结构来调查搜索链接不一致的问题。最后，将链接检查器集成到 CI 流水线中，确保每次部署时都会运行。

技术栈

python

领域

documentationci cddevops

议题类型

功能

难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。

2

预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。

半天

活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。

活跃

清晰度议题是否清楚说明期望改动、验收标准和下一步。

清晰

前置要求

GitPythonMkDocs

新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。

70