First pass at updating en/documentation/index.md #3427
Conversation
LOTS of bitrot on this page. Most has been removed but some have been moved down to an "older" section.
zenspider
force-pushed
the
zenspider/update_docs
branch
from
cbaea65
to
bb2fea0
Compare
|
From my (new to Ruby) perspective, this looks like a massive improvement. Having just completed the Ruby Koans, I can confirm that they are still correct for Ruby 3.3. |
en/documentation/index.md
Outdated
| [The Well-Grounded Rubyist][grounded] | ||
| : A tutorial that begins with your first Ruby program and takes you all the way to sophisticated topics like reflection, threading, and recursion. | ||
|
|
||
| #### Adept |
There was a problem hiding this comment.
As a non-native English speaker, I think Adept is a relatively rare choice of word. Maybe Advanced will be more approachable?
There was a problem hiding this comment.
Maybe Experienced would be better? Advanced and Expert are closer in my mind than Adept/Experienced and Expert are.
There was a problem hiding this comment.
Intermediate sounds good to me 👍
| * Expert | ||
| * [Emacs][20] with [Ruby mode][21] or [Enhanced Ruby mode][enh-ruby-mode] | ||
| * [Vim][25] with [vim-ruby][26] plugin | ||
| * [NeoVim][neovim] |
There was a problem hiding this comment.
I'm not sure if we need or should pair editors with experience levels. For example, I started writing Ruby with Vim, then switched to NeoVim for like 6 years, and switched to VS Code like 2 years ago.
There was a problem hiding this comment.
I think the idea is from an approachability standpoint instead of an end user skill level standpoint.
There was a problem hiding this comment.
yeah, I meant this more about learning curve of the editor
en/documentation/index.md
Outdated
| All of these editors support the Language Server Protocol (LSP). You | ||
| can use Shopify's [ruby-lsp][ruby-lsp] plugin for ruby support. |
There was a problem hiding this comment.
| All of these editors support the Language Server Protocol (LSP). You | |
| can use Shopify's [ruby-lsp][ruby-lsp] plugin for ruby support. | |
| All of these editors support the Language Server Protocol (LSP), either by default or through their LSP plugins. | |
| Shopify's [ruby-lsp][ruby-lsp] is one of the most popular language servers for Ruby and [supports all of the above editors](https://shopify.github.io/ruby-lsp/editors.html) |
|
Pushed some edits based on feedback. Please let me squash and reword before merge (assuming). |
| : The ruby quick reference | ||
|
|
||
| [rubyreferences][43] | ||
| : A full language reference + detailed language changelog. Fantastic. |
There was a problem hiding this comment.
Extra spacing:
| : A full language reference + detailed language changelog. Fantastic. | |
| : A full language reference + detailed language changelog. Fantastic. |
While I agree it's a fantastic work, it feels a bit odd to add Fantastic. in its description?
| * [Zed][zed] | ||
| * Intermediate | ||
| * [RubyMine][27] (paid) | ||
| * Expert |
There was a problem hiding this comment.
Nit: Maybe "difficult" can fit the tooling context better than "expert"?
| * Expert | |
| * Difficult |
| [Airbnb][48] | ||
| : AirBNB's Ruby style guide | ||
|
|
||
| [w3resource][49] |
There was a problem hiding this comment.
Thank you for your contribution and for adding helpful links 🙌🏻 I noticed this one has significant number of ads (screenshot below). While the content looks valuable, I wonder if we should consider whether this is a good addition to be on the documentation page on the Ruby official website 🤔
| #### Beginner | ||
|
|
||
| [Programming Ruby 3.3][pickaxe] | ||
| : The seminal work on Ruby in English. Recently updated to ruby 3.3. |
There was a problem hiding this comment.
| : The seminal work on Ruby in English. Recently updated to ruby 3.3. | |
| : The seminal work on Ruby in English. Recently updated to Ruby 3.3. |
| #### Intermediate | ||
|
|
||
| [Practical OOD in Ruby (POODR)][poodr] | ||
| : A programmers tale about how to write object-oriented code. |
There was a problem hiding this comment.
| : A programmers tale about how to write object-oriented code. | |
| : A programmer's tale about how to write object-oriented code. |
| : Explains metaprogramming in a down-to-earth style. | ||
|
|
||
| [Ruby Under a Microscope (RUM)][microscope] | ||
| : An illustrated guide to ruby internals. |
There was a problem hiding this comment.
| : An illustrated guide to ruby internals. | |
| : An illustrated guide to Ruby internals. |
| ### Style Guides | ||
|
|
||
| [rubystyle.guide][44] | ||
| : Rubocop's Ruby style guide |
There was a problem hiding this comment.
| : Rubocop's Ruby style guide | |
| : RuboCop's Ruby style guide |
| : Gitlab's Ruby style guide | ||
|
|
||
| [Airbnb][48] | ||
| : AirBNB's Ruby style guide |
There was a problem hiding this comment.
| : AirBNB's Ruby style guide | |
| : Airbnb's Ruby style guide |
| : AirBNB's Ruby style guide | ||
|
|
||
| [w3resource][49] | ||
| : W3's Ruby style guide |
There was a problem hiding this comment.
I'd suggest dropping this, it seems to be a copy-paste of Airbnb's guide.
| : online API documentation | ||
|
|
||
| [Ruby QuickRef][42] | ||
| : The ruby quick reference |
There was a problem hiding this comment.
| : The ruby quick reference | |
| : The Ruby quick reference |
There was a problem hiding this comment.
I would add that this is for both the language and the standard library. Many references for other languages cover just one or the other.
| [Programming Ruby][9] | ||
| : The seminal work on Ruby in English, this first edition of the | ||
| [Pragmatic Programmers’ book][10] is available for free online. |
There was a problem hiding this comment.
| [Programming Ruby][9] | |
| : The seminal work on Ruby in English, this first edition of the | |
| [Pragmatic Programmers’ book][10] is available for free online. | |
| [Programming Ruby][9] | |
| : The first edition of this seminal work on Ruby in English is available for free online. |
The current edition is already linked to in the Books section.
main changes:
LOTS of bitrot on this page. Most has been removed but some have been
moved down to an "older" section.
Revamped editor section to include difficulty "levels"
Added a bunch of sections and links mostly derived from the ruby
discord's #library.
This fixes #3426