From ed6d9cf1c6b3d0b87783c29bbf6b3820fc28bbc4 Mon Sep 17 00:00:00 2001 From: Lucian Ghinda <1407869+lucianghinda@users.noreply.github.com> Date: Sun, 25 Aug 2024 18:11:38 +0300 Subject: [PATCH] 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. --- en/documentation/index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/en/documentation/index.md b/en/documentation/index.md index 30d9be0bf9..b0ded8f30c 100644 --- a/en/documentation/index.md +++ b/en/documentation/index.md @@ -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/) @@ -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]