Skip to content

Commit

Permalink
Add index troubleshooting steps
Browse files Browse the repository at this point in the history
  • Loading branch information
andyw8 committed Sep 30, 2024
1 parent 3153522 commit a62e22d
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion jekyll/troubleshooting.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ For example, if you configure `BUNDLE_PATH` to point to `vendor/bundle` so that
directory as your project, `bundle install` will automatically pick that up and install them in the right place. But
`gem install` will not as it requires a different setting to achieve it.

You can apply your prefered installed locations for RubyGems by using the `~/.gemrc` file. In that file, you can decide
You can apply your preferred installed locations for RubyGems by using the `~/.gemrc` file. In that file, you can decide
to either install it with `--user-install` or select a specific installation directory with `--install-dir`.

```yaml
Expand Down Expand Up @@ -230,6 +230,18 @@ ruby-lsp
Is there any extra information given from booting the server manually? Or does it only fail when booting through the
extension?

## Indexing

When Ruby LSP starts, it attempts to index your code as well as your dependencies as described in [Configuring code indexing](index.html#configuring-code-indexing).

In rare cases, Ruby LSP will encounter an error which prevents indexing from completing, which will result in incomplete information in the editor.

Firstly, ensure that you are using the latest release of the `ruby-lsp` gem, as the problem may have been already fixed.

To diagnose the particular file(s) causing a problem, run `ruby-lsp-check`. Please log an issue so that we can address it. If the code is not open source then please provide a minimal reproduction.

In the meantime, you can [configure Ruby LSP to ignore a particular gem or file for indexing](index.html#configuring-code-indexing).

## After troubleshooting

If after troubleshooting the Ruby LSP is still not initializing properly, please report an issue
Expand Down

0 comments on commit a62e22d

Please sign in to comment.