Broken link checking should not rely on readers
Open
Nobody has claimed this yet.
blocked-by-upstream
bug
enhancement
help wanted
repo
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
What is the URL of the page where you experience the error?
Potentially all
What is the issue with this page?
Since the new docs are build by an automatic process, it should not be left to readers to find broken links like #186. The build system should find them. (Surely this is a standard feature of whatever package we are using?)
Are you able to provide a patch for this?
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the automatic documentation build configuration and identifying the package or command that generates the docs. Confirm how a deliberately broken link is handled, then make the build report broken links and fail appropriately; done means link errors are detected without reader reports.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100