RubyMine 2018.1 Help

Using Help Topics

In this section:

Documentation structure

RubyMine documentation has the following structure:

Meet RubyMine

This part contains system requirements and installation information, quick start guide that helps you get a grip of RubyMine, the section First Steps with the tutorials that help you perform the most basic actions - create and run your first application.

How to

This contains information related to the platform features (such as, for example, using the RubyMine editor, tool windows, or version control) .


This part contains miscellaneous information such as basic concepts, or essentials, dialogs reference, icons reference, and more.

Online documentation

On the RubyMine site, find online documentation:

RubyMine web help

The online version makes it possible to find entries in the table of contents, browse documentation with the table of contents, rate topics and express your opinion. The layout of online documentation consists of:

Table of contents pane

This pane shows the table of contents.

  • Use this pane to browse through the topics.
  • Click hide toc button to show or hide this pane.
  • If for some reason your browser fails to show actual table of contents, refresh the page.

Topics pane

This pane shows the topic that is currently selected in the table of contents.

  • In the Keymap drop-down list, choose the platform you want to view keyboard shortcuts in (Windows/Linux, macOS etc.)

Finding a piece of information in the table of contents

  1. Switch to the Table of contents pane.
  2. In the Search RubyMine help field, type your query.
  3. Press Enter.

    The table contents shrinks to show the search results. Click the desired entry to show the corresponding page in the Topic pane.

Last modified: 1 August 2018