awesomeWM/awesome

Automatically catch broken links in the docs

Open

#3,098 opened on 2020年5月10日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Lua (620 forks)batch import
docenhancementgood first issue

Repository metrics

Stars
 (6,882 stars)
PR merge metrics
 (平均マージ 37d 2h) (30d で 1 merged 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
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80