Repository navigation
Dead link in the README.md #804
Description
Hi,
I found that this link https://ruby-doc.org/stdlib/exts/readline/Readline.html in the README.md is 404 Not Found.
❯ curl -X GET -IL https://ruby-doc.org/stdlib/exts/readline/Readline.html
HTTP/1.1 302 Found
Date: Wed, 08 Jan 2025 16:38:30 GMT
Server: Apache/2.4.29 (Ubuntu)
Location: https://ruby-doc.org/3.4.1/exts/readline/Readline.html
Content-Length: 317
Content-Type: text/html; charset=iso-8859-1
HTTP/1.1 404 Not Found
Date: Wed, 08 Jan 2025 16:38:31 GMT
Server: Apache/2.4.29 (Ubuntu)
Last-Modified: Mon, 03 Jul 2023 00:21:33 GMT
ETag: "1c42-5ff8a261a6507"
Accept-Ranges: bytes
Content-Length: 7234
Content-Type: text/html
/stdlib/exts/readline/Readline.html does not exist in 3.4.1 doc. There are a few pages related to Readline but they appear blank.
3.3.6 has the same issue.
3.2.6 does not have the issue. https://ruby-doc.org/3.2.6/exts/readline/Readline.html exists.
I am not sure what approach is the best:
- Report it to the maintainer of the English version of ruby-org to ask them to revert the page (if possible)
- Update the link in the README.md to https://ruby-doc.org/3.2.6/exts/readline/Readline.html
- Update the link in the README.md to https://github.com/ruby/readline-ext or https://www.rubydoc.info/gems/readline-ext/file/README.md or https://www.rubydoc.info/gems/readline-ext/Readline
so just reporting it to the Reline maintainers.
Activity
st0012 commentedon Jan 8, 2025
ruby-doc.org is NOT the official documentation website, nor is
rubydoc.info. The official one is https://docs.ruby-lang.org/en and I don't think it has this problem as the sidebar section you screenshotted seems to be a customization of ruby-doc.org.So unless there's also a deadlink on the official website, there's nothing we can fix here.
kyanny commentedon Jan 9, 2025
Hi @st0012 thank you for the comment.
https://docs.ruby-lang.org/en/master/Readline.html exists (good news) but it looks less informative than https://ruby-doc.org/3.2.6/exts/readline/Readline.html (bad news)
If you agree with updating the link in README.md to https://docs.ruby-lang.org/en/master/Readline.html I am happy to open a pull request.
(just in case - I am talking about this dead link)
ima1zumi commentedon Jan 9, 2025
The page at https://docs.ruby-lang.org/en/master/Readline.html is displaying Reline documentation instead of Readline documentation. We should fix RDoc or RDoc generation process.
kyanny commentedon Jan 9, 2025
readlineis no longer a standard library (now it's readline-ext gem) so its documentation never shows up on https://docs.ruby-lang.org/en/, am I correct?Does it make sense to remove the link from the README.md like below?
st0012 commentedon Jan 9, 2025
Ah yes, we should fix it. Sorry that I missed that part.
I believe it comes from: https://github.com/ruby/ruby/blob/master/lib/readline.rb#L6. If you remove this part
Readlinedisappears from the generated documentation.Since
ruby/rubyis aliasing the constants, I think this is a correct behaviour. We can, however, excludereadline.rbfrom documentation generation by updatingruby/ruby's rdoc config.st0012 commentedon Jan 9, 2025
Ideally, I think reline should have its own documentation for all of its features and stop referencing to readline's docs.