Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation page #3355

Merged
merged 2 commits into from
Sep 2, 2024
Merged

Improve documentation page #3355

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5ff9bb
Remove dead or outdated links
st0012 Aug 27, 2024
57833a4
Make the link to VS Code directly visit its Ruby doc
st0012 Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 1 addition & 23 deletions en/documentation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,6 @@ the [installation guide](installation/) for help on installing Ruby.
: The official Ruby API documentation for different versions including
the currently unreleased (trunk) version.

[Ruby Core Reference][13]
: Pulled straight from the source code using [RDoc][14], this reference
work documents all of the core classes and modules (like String,
Array, Symbol, etc…).

[Ruby Standard Library Reference][15]
: Also pulled from the source code using RDoc, this reference work
documents the standard library.

[Ruby C API Reference][extensions]
: The official introduction to Ruby's C API.
Great if you want to write C extensions
Expand All @@ -73,12 +64,6 @@ the [installation guide](installation/) for help on installing Ruby.
: The one-stop web site for reference documentation about Ruby gems and
GitHub-hosted Ruby projects.

[Ruby & Rails Searchable API Docs][17]
: Rails and Ruby documentation with smart searching.

[APIdock][18]
: Ruby, Rails and RSpec documentation with users’ notes.

[RubyAPI.org][rubyapi-org]
: Easily find and browse Ruby classes, modules, and methods.

Expand Down Expand Up @@ -125,8 +110,6 @@ documentation sources.
If you have questions about Ruby the
[mailing list](/en/community/mailing-lists/) is a great place to start.



[1]: https://try.ruby-lang.org/
[2]: https://rubykoans.com/
[5]: https://poignant.guide
Expand All @@ -135,13 +118,8 @@ If you have questions about Ruby the
[9]: http://www.ruby-doc.org/docs/ProgrammingRuby/
[10]: http://pragmaticprogrammer.com/titles/ruby/index.html
[12]: http://en.wikibooks.org/wiki/Ruby_programming_language
[13]: http://www.ruby-doc.org/core
[14]: https://ruby.github.io/rdoc/
[15]: http://www.ruby-doc.org/stdlib
Comment on lines -138 to -140
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both [13] and [15] redirects to https://ruby-doc.org/3.3.4/ now, so I think we don't have to remove these?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[34] also links to http://ruby-doc.org, it needs to be https though.

[extensions]: https://docs.ruby-lang.org/en/master/extension_rdoc.html
[16]: http://www.rubydoc.info/
[17]: http://rubydocs.org/
[18]: http://apidock.com/
[rubyapi-org]: https://rubyapi.org/
[19]: http://www.aptana.com/
[20]: http://www.gnu.org/software/emacs/
Expand All @@ -165,7 +143,7 @@ If you have questions about Ruby the
[39]: http://kapeli.com/dash
[docs-rlo-en]: https://docs.ruby-lang.org/en/
[atom]: https://atom.io/
[vscode]: https://code.visualstudio.com/
[vscode]: https://code.visualstudio.com/docs/languages/ruby
[eric]: https://eric-ide.python-projects.org/
[kdevelop]: https://www.kdevelop.org/
[kate]: https://kate-editor.org/