Skip to content

Commit cbaea65

Browse files
committed
First pass at updating en/documentation/index.md
LOTS of bitrot on this page. Most has been removed but some have been moved down to an "older" section.
1 parent 5f5ce6d commit cbaea65

File tree

1 file changed

+180
-78
lines changed

1 file changed

+180
-78
lines changed

en/documentation/index.md

Lines changed: 180 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -18,48 +18,56 @@ The authoritative Ruby language documentation at [docs.ruby-lang.org][docs-rlo-e
1818

1919
### Getting Started
2020

21-
[Official FAQ](/en/documentation/faq/)
22-
: The official frequently asked questions.
23-
24-
[Ruby Koans][2]
25-
: The Koans walk you along the path to enlightenment in order to learn
26-
Ruby. The goal is to learn the Ruby language, syntax, structure, and
27-
some common functions and libraries. We also teach you culture.
28-
29-
[Why’s (Poignant) Guide to Ruby][5]
30-
: An unconventional but interesting book that will teach you Ruby
31-
through stories, wit, and comics. Originally created by *why the lucky
32-
stiff*, this guide remains a classic for Ruby learners.
33-
34-
[Ruby Essentials][7]
35-
: A free on-line book designed to provide a concise
36-
and easy to follow guide to learning Ruby.
21+
[Try Ruby][1]
22+
: You can try Ruby right in your browser.
3723

3824
[Learn to Program][8]
3925
: A wonderful little tutorial by Chris Pine for programming newbies. If
4026
you don’t know how to program, start here.
4127

42-
[Learn Ruby the Hard Way][38]
43-
: A very good set of exercises with explanations that guide you from
44-
the absolute basics of Ruby all the way to OOP and web development.
28+
[Ruby in Twenty Minutes][rubyin20]
29+
: A small Ruby tutorial that should take no more than 20 minutes to
30+
complete.
4531

46-
### Manuals
32+
[The Odin Project][odin]
33+
: An open source full stack curriculum
4734

48-
[Programming Ruby][9]
49-
: The seminal work on Ruby in English, this first edition of the
50-
[Pragmatic Programmers’ book][10] is available for free online.
35+
[excercism][exercism]
36+
: 120 exercises with automatic analysis and personal mentoring.
5137

52-
[The Ruby Programming Wikibook][12]
53-
: A free online manual with beginner and intermediate content plus a
54-
thorough language reference.
38+
[Codecademy][codecademy]
39+
: Online code bootcamp with a variety of topics. Freeish.
40+
41+
### Manuals / Books
42+
43+
#### Beginner
44+
45+
[Programming Ruby 3.3][pickaxe]
46+
: The seminal work on Ruby in English. Recently updated to ruby 3.3.
47+
48+
[The Well-Grounded Rubyist][grounded]
49+
: A tutorial that begins with your first Ruby program and takes you all the way to sophisticated topics like reflection, threading, and recursion.
50+
51+
#### Adept
52+
53+
[Practical OOD in Ruby (POODR)][poodr]
54+
: A programmers tale about how to write object-oriented code.
55+
56+
#### Expert
57+
58+
[Metaprogramming][meta]
59+
: Explains metaprogramming in a down-to-earth style.
60+
61+
[Ruby Under a Microscope (RUM)][microscope]
62+
: An illustrated guide to ruby internals.
5563

5664
### Reference Documentation
5765

58-
[Official API Documentation][docs-rlo-en]
66+
[Official API Documentation][docs-rlo-en] [(JP)][docs-rlo-jp]
5967
: The official Ruby language documentation for different versions including
6068
the currently unreleased (trunk) version.
6169

62-
[Ruby C API Reference][extensions]
70+
[Ruby C API Reference][extensions] [(JP)][extensions-jp]
6371
: The official introduction to Ruby's C API.
6472
Great if you want to write C extensions
6573
or contribute to Ruby’s development.
@@ -71,6 +79,61 @@ The authoritative Ruby language documentation at [docs.ruby-lang.org][docs-rlo-e
7179
[RubyAPI.org][rubyapi-org]
7280
: Easily find and browse Ruby classes, modules, and methods.
7381

82+
[ruby-doc.org][39]
83+
: online API documentation
84+
85+
[DevDocs.io][40]
86+
: online API documentation
87+
88+
[Ruby QuickRef][42]
89+
: The ruby quick reference
90+
91+
[rubyreferences][43]
92+
: A full language reference + detailed language changelog. Fantastic.
93+
94+
### Style Guides
95+
96+
[rubystyle.guide][44]
97+
: Rubocop's Ruby style guide
98+
99+
[RuboCop][45]
100+
: Automated enforcement of their style guide.
101+
102+
[Shopify][46]
103+
: Shopify's Ruby style guide
104+
105+
[GitLab][47]
106+
: Gitlab's Ruby style guide
107+
108+
[Airbnb][48]
109+
: AirBNB's Ruby style guide
110+
111+
[w3resource][49]
112+
: W3's Ruby style guide
113+
114+
# Tools
115+
116+
[IRB][50]
117+
: The interactive Ruby Read-Eval-Print-Loop (REPL)
118+
119+
[Pry][51]
120+
: An alternative Ruby REPL
121+
122+
[Rake][52]
123+
: A make-like build utility for Ruby.
124+
125+
[RI][53]
126+
: (Ruby Information) is the Ruby command-line utility that gives fast and easy on-line access to Ruby documentation.
127+
128+
[RBS][54]
129+
: Type Signature for Ruby
130+
131+
[TypeProf][55]
132+
: An experimental type-level Ruby interpreter for testing and understanding Ruby code.
133+
134+
[Steep][56]
135+
: Static type checker for Ruby.
136+
74137
### Editors and IDEs
75138

76139
For coding in Ruby, you can use the default editor of your operating
@@ -81,69 +144,108 @@ testing support).
81144

82145
Here is a list of popular tools used by Rubyists:
83146

84-
* Linux and cross-platform tools:
85-
* [Aptana Studio][19]
86-
* [Atom][atom]
87-
* [Emacs][20] with [Ruby mode][21] and [Rsense][22]
88-
* [Eric][eric]
89-
* [Geany][23]
90-
* [gedit][24]
91-
* [Kate][kate]
92-
* [KDevelop][kdevelop]
93-
* [NetBeans][36]
94-
* [RubyMine][27]
95-
* [SciTe][28]
147+
* Easy
96148
* [Sublime Text][37]
97-
* [Vim][25] with [vim-ruby][26] plugin and [Rsense][22]
98149
* [Visual Studio Code][vscode]
150+
* [Zed][zed]
151+
* Adept
152+
* [RubyMine][27] (paid)
153+
* Expert
154+
* [Emacs][20] with [Ruby mode][21] or [Enhanced Ruby mode][enh-ruby-mode]
155+
* [Vim][25] with [vim-ruby][26] plugin
156+
* [NeoVim][neovim]
99157

100-
* On Windows:
101-
* [Notepad++][29]
102-
103-
* On macOS:
104-
* [TextMate][32]
105-
* [BBEdit][33]
106-
* [Dash][39] (documentation browser)
158+
All of these editors support the Language Server Protocol (LSP). You
159+
can use Shopify's [ruby-lsp][ruby-lsp] plugin for ruby support.
107160

108161
### Further Reading
109162

163+
[Official FAQ](/en/documentation/faq/)
164+
: The official frequently asked questions.
165+
110166
[Ruby-doc.org][34] maintains a comprehensive list of English
111167
documentation sources.
112-
If you have questions about Ruby the
113-
[mailing list](/en/community/mailing-lists/) is a great place to start.
168+
169+
### Older Reading / Resources
170+
171+
These links were more prominent but haven't been updated in ages.
172+
173+
[Ruby Koans][2]
174+
: The Koans walk you along the path to enlightenment in order to learn
175+
Ruby. The goal is to learn the Ruby language, syntax, structure, and
176+
some common functions and libraries. We also teach you culture.
177+
178+
[Ruby Essentials][7]
179+
: A free on-line book designed to provide a concise
180+
and easy to follow guide to learning Ruby.
181+
182+
[Why’s (Poignant) Guide to Ruby][5]
183+
: An unconventional but interesting book that will teach you Ruby
184+
through stories, wit, and comics. Originally created by *why the lucky
185+
stiff*, this guide remains a classic for Ruby learners.
186+
187+
[Learn Ruby the Hard Way][38]
188+
: A very good set of exercises with explanations that guide you from
189+
the absolute basics of Ruby all the way to OOP and web development.
190+
191+
[Programming Ruby][9]
192+
: The seminal work on Ruby in English, this first edition of the
193+
[Pragmatic Programmers’ book][10] is available for free online.
194+
195+
[The Ruby Programming Wikibook][12]
196+
: A free online manual with beginner and intermediate content plus a
197+
thorough language reference.
114198

115199
[1]: https://try.ruby-lang.org/
116200
[2]: https://rubykoans.com/
117201
[5]: https://poignant.guide
118-
[7]: http://www.techotopia.com/index.php/Ruby_Essentials
119-
[8]: http://pine.fm/LearnToProgram/
120-
[9]: http://www.ruby-doc.org/docs/ProgrammingRuby/
202+
[7]: https://www.techotopia.com/index.php/Ruby_Essentials
203+
[8]: https://pine.fm/LearnToProgram/
204+
[9]: https://www.ruby-doc.org/docs/ProgrammingRuby/
121205
[10]: https://pragprog.com/titles/ruby5/programming-ruby-3-3-5th-edition/
122-
[12]: http://en.wikibooks.org/wiki/Ruby_programming_language
123-
[extensions]: https://docs.ruby-lang.org/en/master/extension_rdoc.html
124-
[16]: http://www.rubydoc.info/
125-
[rubyapi-org]: https://rubyapi.org/
126-
[19]: http://www.aptana.com/
127-
[20]: http://www.gnu.org/software/emacs/
128-
[21]: http://www.emacswiki.org/emacs/RubyMode
129-
[22]: http://rsense.github.io/
130-
[23]: http://www.geany.org/
131-
[24]: http://projects.gnome.org/gedit/screenshots.html
132-
[25]: http://www.vim.org/
206+
[12]: https://en.wikibooks.org/wiki/Ruby_programming_language
207+
[16]: https://www.rubydoc.info/
208+
[20]: https://www.gnu.org/software/emacs/
209+
[21]: https://www.emacswiki.org/emacs/RubyMode
210+
[25]: https://www.vim.org/
133211
[26]: https://github.com/vim-ruby/vim-ruby
134-
[27]: http://www.jetbrains.com/ruby/
135-
[28]: http://www.scintilla.org/SciTE.html
136-
[29]: http://notepad-plus-plus.org/
137-
[32]: http://macromates.com/
138-
[33]: https://www.barebones.com/products/bbedit/
139-
[34]: http://ruby-doc.org
140-
[36]: https://netbeans.org/
141-
[37]: http://www.sublimetext.com/
212+
[27]: https://www.jetbrains.com/ruby/
213+
[34]: https://ruby-doc.org/
214+
[37]: https://www.sublimetext.com/
142215
[38]: https://learncodethehardway.org/ruby/
143-
[39]: http://kapeli.com/dash
144-
[docs-rlo-en]: https://docs.ruby-lang.org/en/
145-
[atom]: https://atom.io/
216+
[39]: https://www.ruby-doc.org/
217+
[40]: https://devdocs.io/ruby/
218+
[42]: https://www.zenspider.com/ruby/quickref.html
219+
[43]: https://rubyreferences.github.io/
220+
[44]: https://rubystyle.guide/
221+
[45]: https://github.com/rubocop/ruby-style-guide
222+
[46]: https://ruby-style-guide.shopify.dev/
223+
[47]: https://docs.gitlab.com/ee/development/backend/ruby_style_guide.html
224+
[48]: https://github.com/airbnb/ruby
225+
[49]: https://www.w3resource.com/ruby/ruby-style-guide.php
226+
[50]: https://github.com/ruby/irb
227+
[51]: https://github.com/pry/pry
228+
[52]: https://github.com/ruby/rake
229+
[53]: https://ruby.github.io/rdoc/RI_md.html
230+
[54]: https://github.com/ruby/rbs
231+
[55]: https://github.com/ruby/typeprof
232+
[56]: https://github.com/soutaro/steep
233+
[codecademy]: https://www.codecademy.com/learn/learn-ruby
234+
[docs-rlo-en]: https://docs.ruby-lang.org/en/latest
235+
[docs-rlo-jp]: https://docs.ruby-lang.org/ja/latest
236+
[enh-ruby-mode]: https://github.com/zenspider/enhanced-ruby-mode/
237+
[exercism]: https://exercism.org/tracks/ruby
238+
[extensions-jp]: https://docs.ruby-lang.org/jp/master/extension_rdoc.html
239+
[extensions]: https://docs.ruby-lang.org/en/master/extension_rdoc.html
240+
[grounded]: https://www.manning.com/books/the-well-grounded-rubyist-third-edition
241+
[meta]: https://pragprog.com/titles/ppmetr2/metaprogramming-ruby-2/
242+
[microscope]: https://patshaughnessy.net/ruby-under-a-microscope
243+
[neovim]: https://neovim.io/
244+
[odin]: https://www.theodinproject.com/
245+
[pickaxe]: https://pragprog.com/titles/ruby5/programming-ruby-3-3-5th-edition/
246+
[poodr]: https://www.poodr.com/
247+
[ruby-lsp]: https://github.com/Shopify/ruby-lsp
248+
[rubyapi-org]: https://rubyapi.org/
249+
[rubyin20]: https://www.ruby-lang.org/en/documentation/quickstart/
146250
[vscode]: https://code.visualstudio.com/docs/languages/ruby
147-
[eric]: https://eric-ide.python-projects.org/
148-
[kdevelop]: https://www.kdevelop.org/
149-
[kate]: https://kate-editor.org/
251+
[zed]: https://zed.dev/

0 commit comments

Comments
 (0)