ruby / ruby/reline

Dead link in the README.md

Open
#804 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
311
Forks
99
Avg merge
6d 4h
Merged PRs (30d)
1

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.

Image

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:

so just reporting it to the Reline maintainers.

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 in README.md and inspect the broken Readline documentation link. Check the candidate ruby-doc.org, ruby/readline-ext, and rubydoc.info destinations listed in the issue, then confirm the preferred target with the Reline maintainers. Done means README.md no longer points to the reported 404 page.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.