docs: placeholder URLs that cannot resolve, instead of ones that 404 - #21
Merged
Merged
Conversation
Closes #20. Measured: https://github.com/org/Pkg.jl/issues/12 404 resolves, and fails https://github.com/org/MyPackage.jl/issues/12 404 https://example.invalid/issues/12 000 does not resolve, by design The first two reach GitHub and come back 404, so a reviewer running a link checker sees two dead links — which is the finding that opened the review of another package in this organisation. `example.invalid` is reserved by RFC 2606 and cannot resolve, which is what a placeholder should look like. The package's own tests already used it; six sites in `docs/src` and `src` did not. The lint that keeps it that way does not use the network — a check that asks for a response would be a flake generator across three runners. The property is the host: a URL inside a fenced julia block must be under a reserved example domain or on a host this organisation owns. Verified by restoring one of the old URLs and watching it fail, naming the file and the URL. Suite: 1022 passed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
Contributor
|
📚 Docs preview: https://codes.sota-shimozono.com/ExperimentalAPI.jl/previews/PR21/ (updates on each push to this PR) |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #20.
Measured:
https://github.com/org/Pkg.jl/issues/12https://github.com/org/MyPackage.jl/issues/12https://example.invalid/issues/12The first two reach GitHub and come back 404, so a reviewer running a link checker sees two dead links — which is the finding that opened the review of another package in this organisation.
example.invalidis reserved by RFC 2606 and cannot resolve, which is what a placeholder should look like.The package's own tests already used it. Six sites in
docs/srcandsrcdid not.The lint does not use the network
A check that asks for a response would be a flake generator across three runners, and would fail on an offline build for a reason unrelated to the claim. The property is the host: a URL inside a fenced julia block must be under a reserved example domain, or on a host this organisation owns.
Control run — restoring one of the old URLs:
Suite: 1022 passed.
🤖 Generated with Claude Code