Add section about official Ruby Language Documentation #3352
Conversation
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
The purpose of this commit is to: - Introduce new section highlighting docs.ruby-lang.org as the authoritative source for Ruby language documentation - Clarify that this should be the first reference for learning Ruby or when having the need to understand how Ruby works - Explain that other resources are complementary or present documentation in different styles - Try to help quickly identify for the reader what is the official Ruby language documentation.
st0012
reviewed
Aug 25, 2024
| @@ -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] | |||
There was a problem hiding this comment.
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)
|
@ruby/www-ruby-lang-org-editorial would you mind giving this a review? Thanks |
hsbt
approved these changes
Nov 13, 2024
lucianghinda
deleted the
lg/move-ruby-documentation-to-the-top-and-improve-wording
branch
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.
Context
For this I think it is good to move the link to the official documentation at the top of the page.
For this, I think it is good to use a wording that says "the Ruby language documentation" instead of "the Ruby API documentation"
Changes
Introduce new section highlighting docs.ruby-lang.org as the authoritative source for Ruby language documentation
Clarify that this should be the first reference for learning Ruby or when having the need to understand how Ruby works
Explain that other resources are complementary or present documentation in different styles
Try to help quickly identify the official Ruby language documentation for the reader by removing an acronym and replacing it with an explicit wording
PS: I am not an English speaker, so if anyone can help with better phrasing, please do so.