awesomeWM/awesome

Automatically catch broken links in the docs

Open

#3,098 创建于 2020年5月10日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Lua (620 fork)batch import
docenhancementgood first issue

仓库指标

Star
 (6,882 star)
PR 合并指标
 (平均合并 37天 2小时) (30 天内合并 1 个 PR)

描述

Currently, things like #3097 are caught accidentally when someone sees the breakage. Is it possible to automatically extract all links from the generated docs and catch broken links? Surely there are tools for that.

贡献者指南

研究方向
使用类似 lychee 或 broken link checker 的工具，在 CI 中自动扫描文档链接。
技术栈
lua
领域
documentation
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80