JuliaDocs/Documenter.jl

Avoid checking same link multiple times?

Open

#1,700 opened on Sep 16, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

Right now, every link in the document is checked but in theory each unique URL only needs to be checked once. It's not a big concern, but I have seen some flaky servers that timeout a small fraction of the time, and so checking the link more than once gives more chance of timeout and also means more time waiting for these slow servers

Contributor guide

Research direction
Implement caching of checked URLs to avoid duplicate link checks. Use a set to store visited URLs and skip them if already checked.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65