Skip to content

Commit

Permalink
Add section about official Ruby Language Documentation
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lucianghinda authored and hsbt committed Nov 13, 2024
1 parent 40f7849 commit ed6d9cf
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion en/documentation/index.md
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 C API Reference][extensions]
Expand Down

0 comments on commit ed6d9cf

Please sign in to comment.