Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add section about official Ruby Language Documentation #3352

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Add section about official Ruby Language Documentation #3352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion en/documentation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Guides, tutorials, and reference material to help you learn more about Ruby
Although you can easily [try Ruby in your browser][1], you can also read
the [installation guide](installation/) for help on installing Ruby.

### Ruby Language Documentation

The authoritative Ruby language documentation at [docs.ruby-lang.org][docs-rlo-en] is the place to start if you want to understand Ruby. It covers all aspects of the language and should be the first place you look when learning or referencing Ruby programming language. Other resources listed below are complementary to the official language documentation or they present Ruby documentation in a different format/style/flavor.

### Getting Started

[Official FAQ](/en/documentation/faq/)
Expand Down Expand Up @@ -52,7 +56,7 @@ the [installation guide](installation/) for help on installing Ruby.
### Reference Documentation

[Official API Documentation][docs-rlo-en]
: The official Ruby API documentation for different versions including
: The official Ruby language documentation for different versions including
the currently unreleased (trunk) version.

[Ruby Core Reference][13]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both link 13 and 15 are pointing to outdated source on ruby-doc.org: https://ruby-doc.org/3.2.2/, which has the same content as docs.ruby-lang.org. Since they don't serve additional information nor have better UX (IMO), I think we can remove them to shorten the list.

Additionally, link 17 (https://rubydocs.org/) is blank and link 18 (https://apidock.com/) only has documentation up to 2.6. So they should be removed as well.

(I'm happy to open a separate PR to remove them if it's out of the scope of this PR)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened #3355 to remove them.

Expand Down