awesomeWM/awesome

Automatically catch broken links in the docs

Open

#3098 aperta il 10 mag 2020

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Lua (620 fork)batch import
docenhancementgood first issue

Metriche repository

Star
 (6882 star)
Metriche merge PR
 (Merge medio 37g 2h) (1 PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Configura uno strumento come lychee o broken link checker per scansionare automaticamente i link della documentazione durante la CI.
Tech stack
lua
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80