Fix two dead links in the docs - #23744
Merged
Merged
Conversation
The Cask Cookbook example for disambiguating a name clash by prepending the vendor pointed at Casks/u/unison.rb and Casks/p/panic-unison.rb. Both 404: unison was renamed to unison-app, which is the *next* bullet's rule, and panic-unison no longer exists at all, so the example demonstrated neither half of the rule it illustrated. caffeine and domzilla-caffeine are both live, are both named "Caffeine" with different vendors, and show the rule exactly. Troubleshooting pointed readers at the Discourse archive. discourse.brew.sh is NXDOMAIN, so there is nothing to search.
Contributor
|
Thanks for your pull request. This has been closed because it appears to be missing the pull request template, perhaps because this was written by an AI not a human. We require humans to read and fill in these templates. Please edit this pull request to fill in the current pull request template. This workflow will reopen this pull request automatically once the template is complete. Do not open a new pull request for this. |
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
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.
brew benchmarkresults.brewcommands to reproduce the bug?brew lgtm(style, typechecking and tests) locally?What these changes do
Two dead links in
docs/, found by requesting every URL in that directory.docs/Cask-Cookbook.mdillustrates "if the result conflicts with an existing cask or formula, prepend the name of the vendor or developer" withCasks/u/unison.rbandCasks/p/panic-unison.rb. Both return 404 from the GitHub contents API onHEAD.unisonwas renamed tounison-app—cask_renames.jsoncarries{"unison": "unison-app"}— which is the following bullet's rule (append-appfor a formula clash), andpanic-unisonno longer exists at all. So the example demonstrated neither half of the rule it was attached to, and its surviving half now demonstrates a different rule.Replaced with
caffeineanddomzilla-caffeine. Both are live, both are named exactly "Caffeine", and their homepages are different vendors (intelliscapesolutions.comandcaffeine-app.net), so the pair shows a real name clash resolved by prepending the developer. I chose it by listing all 7,721 tokens fromformulae.brew.sh/api/cask.jsonand keeping pairs where bothvendor-nameandnameexist and the display names match.docs/Troubleshooting.mdsent readers to the Discourse archive as "read-only historical material".discourse.brew.shis NXDOMAIN — the Google and Cloudflare resolvers both return no record, whiledocs.brew.shresolves — so there is nothing there to search. The sentence now says the archive is offline and keeps the warning that quoted material is outdated, which is still useful when it surfaces in an old thread. The GitHub Discussions link on the line above is untouched and returns 200.Why I would like them included
Both links sit in the paths people are sent to when they are already stuck: the cookbook rule a first-time cask author reads, and the troubleshooting page. A 404 there costs the reader the example that was supposed to explain the rule.
On the three unticked boxes
brewcommands to reproduce it. The reproduction is requesting the two URLs, both of which I re-verified through the contents API andnslookuprather than the HTML pages.brew lgtm.brew bundle exec bundle installindocs/fails on this machine withCould not find 'bundler' (4.0.16)against the system Ruby 2.6, and I did not want to install a Ruby toolchain to check a two-line prose change.brew lgtmcovers Ruby style, Sorbet and RSpec, none of which this diff touches; CI owns the docs build.I also left
last_review_datealone in both files. It records that a maintainer reviewed the page, and I touched two lines, so bumping it would claim more than I did.AI/LLM disclosure
Claude (Opus), via Claude Code, ran the link sweep, searched the cask API for a replacement pair and drafted this description. I reviewed the diff and the claims. No commit is attributed to AI: there is no
Assisted-byorCo-developed-bytrailer, per the rule in CONTRIBUTING.md. Every URL claim was re-verified through the GitHub contents API because github.com rate-limited the bulk sweep, and a 429 is indistinguishable from a 404 in a bulk check —domzilla-caffeine.rblooked dead for exactly that reason and was not. This is my only AI-assisted PR open here, per the one-at-a-time rule. I will answer review comments myself.Apologies for the first version of this description: I annotated three of the checkbox lines with parentheses instead of leaving them verbatim and explaining below, which is what tripped the template check.