pyfar / pyfar/gallery

Testing behaviour for dead links in the docs is unstable

Open
#76 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CI workaround exists
Dominant language
Python
Stars
3
Forks
2
Avg merge
2d 3h
Merged PRs (30d)
3

Description

The currently implemented testing for dead links is not a robust indication of actually dead links. We should think of ways to improve this

This issue appeared on #75

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issue #75 and locating the current dead-link testing in the gallery repository. Compare its results with genuinely dead links and establish a reproducible, stable definition of done before choosing an improvement.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing-qa
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.