From 2dd9a4559c3141685f5834678f9e8c9e9e6006c6 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Tue, 31 Dec 2024 22:09:15 +0000 Subject: [PATCH 1/3] Remove unnecessary adjectives --- en/documentation/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/documentation/index.md b/en/documentation/index.md index 9a400be6d9..be1ba59ab3 100644 --- a/en/documentation/index.md +++ b/en/documentation/index.md @@ -36,7 +36,7 @@ The authoritative Ruby language documentation at [docs.ruby-lang.org][docs-rlo-e : 120 exercises with automatic analysis and personal mentoring. [Codecademy][codecademy] -: Online code bootcamp with a variety of topics. Freeish. +: Online code bootcamp with a variety of topics. ### Manuals / Books @@ -89,7 +89,7 @@ The authoritative Ruby language documentation at [docs.ruby-lang.org][docs-rlo-e : The Ruby quick reference [rubyreferences][43] -: A full language reference + detailed language changelog. Fantastic. +: A full language reference + detailed language changelog. ### Style Guides From 38a343aca73b87755386ea4cb9e5716481c053cf Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Tue, 31 Dec 2024 22:38:22 +0000 Subject: [PATCH 2/3] Rework EN documentation section 1. Since ruby-lang.org supports internationalization and has an actively maintained `/ja` version, we don't need to list JA documentation. 2. All official documentation links should be placed in the same section. 3. Fix broken links. --- en/documentation/index.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/en/documentation/index.md b/en/documentation/index.md index be1ba59ab3..75b59bf846 100644 --- a/en/documentation/index.md +++ b/en/documentation/index.md @@ -12,9 +12,15 @@ 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 +### Official Ruby 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. +[docs.ruby-lang.org/en][docs-rlo]: List of documentation for all Ruby versions released after 2.1. + +[docs.ruby-lang.org/en/3.4][docs-rlo-3.4]: Documentation for Ruby 3.4. + +[docs.ruby-lang.org/en/master][docs-rlo-master]: Documentation for the latest Ruby version (master). + +[C Extension Guide][docs-rlo-extension]: In-depth guide for creating C extensions for Ruby. ### Getting Started @@ -61,16 +67,9 @@ The authoritative Ruby language documentation at [docs.ruby-lang.org][docs-rlo-e [Ruby Under a Microscope (RUM)][microscope] : An illustrated guide to Ruby internals. -### Reference Documentation - -[Official API Documentation][docs-rlo-en] [(JP)][docs-rlo-jp] -: The official Ruby language documentation for different versions including - the currently unreleased (trunk) version. +### Community Documentation -[Ruby C API Reference][extensions] [(JP)][extensions-jp] -: The official introduction to Ruby's C API. - Great if you want to write C extensions - or contribute to Ruby’s development. +These documentation sites are maintained by the Ruby community. [RubyDoc.info][16] : The one-stop web site for reference documentation about Ruby gems and @@ -226,12 +225,12 @@ These links were more prominent but haven't been updated in ages. [55]: https://github.com/ruby/typeprof [56]: https://github.com/soutaro/steep [codecademy]: https://www.codecademy.com/learn/learn-ruby -[docs-rlo-en]: https://docs.ruby-lang.org/en/latest -[docs-rlo-jp]: https://docs.ruby-lang.org/ja/latest +[docs-rlo]: https://docs.ruby-lang.org/en +[docs-rlo-3.4]: https://docs.ruby-lang.org/en/3.4 +[docs-rlo-master]: https://docs.ruby-lang.org/en/master +[docs-rlo-extension]: https://docs.ruby-lang.org/en/master/extension_rdoc.html [enh-ruby-mode]: https://github.com/zenspider/enhanced-ruby-mode/ [exercism]: https://exercism.org/tracks/ruby -[extensions-jp]: https://docs.ruby-lang.org/jp/master/extension_rdoc.html -[extensions]: https://docs.ruby-lang.org/en/master/extension_rdoc.html [grounded]: https://www.manning.com/books/the-well-grounded-rubyist-third-edition [meta]: https://pragprog.com/titles/ppmetr2/metaprogramming-ruby-2/ [microscope]: https://patshaughnessy.net/ruby-under-a-microscope From e3a6b3703fb863b771514f6bd021e9b7a9e1d05e Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Wed, 1 Jan 2025 01:07:16 +0000 Subject: [PATCH 3/3] Update en/documentation/index.md Co-authored-by: Jeremy Evans --- en/documentation/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/documentation/index.md b/en/documentation/index.md index 75b59bf846..0ac929e5db 100644 --- a/en/documentation/index.md +++ b/en/documentation/index.md @@ -18,7 +18,7 @@ the [installation guide](installation/) for help on installing Ruby. [docs.ruby-lang.org/en/3.4][docs-rlo-3.4]: Documentation for Ruby 3.4. -[docs.ruby-lang.org/en/master][docs-rlo-master]: Documentation for the latest Ruby version (master). +[docs.ruby-lang.org/en/master][docs-rlo-master]: Documentation for Ruby's master branch. [C Extension Guide][docs-rlo-extension]: In-depth guide for creating C extensions for Ruby.