Skip to content

Commit ed6d9cf

Browse files
lucianghindahsbt
authored andcommitted
Add section about official Ruby Language Documentation
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.
1 parent 40f7849 commit ed6d9cf

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

en/documentation/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Guides, tutorials, and reference material to help you learn more about Ruby
1212
Although you can easily [try Ruby in your browser][1], you can also read
1313
the [installation guide](installation/) for help on installing Ruby.
1414

15+
### Ruby Language Documentation
16+
17+
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.
18+
1519
### Getting Started
1620

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

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

5862
[Ruby C API Reference][extensions]

0 commit comments

Comments
 (0)